• Introduction
• Iguana Reference content
• Using the Reference Section

Introduction

The Iguana Reference section is your primary resource for all Iguana Reference Information. Therefore this section covers topics like: How to configure Program Settings, Channel configuration settings, using the Dashboard, working with Channels, Logs and the Translator, etc. Consequently you can quickly find help for any Iguana Reference task by viewing relevant topics, or by using the search box.

Administrators will probably be more interested in the first three topics — as they are mostly about administration functions.

Developers, on the other hand, will find all topics relevant. For example: If you are new to Lua you can look at the Lua section. If you are new to the Translator you should look at the Channels section (channels are basically Iguana’s specialized take on projects). You may also be interested in our HTTP and CDA APIs.

Other useful material: Developers will probably be interested in the Building Interfaces section. Whereas administrators should take a look at the Administration section.

If you cannot find the answer you need please contact us at support@interfaceware.com.

Iguana Reference content [top]

A brief overview of the content in each topic:

• Program Settings:

  This section covers all of the Program Settings for Iguana. You can use program settings to modify various Iguana configuration options, for things like: Licensing information, Web Server and Database settings, Remote Iguana Servers, manage Users and Roles, Import and Export channels to git repositories, manage Environment Variables, etc.

• Channel Settings:

  Here you will find information about the settings for Channels and their Components. This covers things like, using the Control Panel for channel settings, configuring settings for a channel, and configuring settings for channel components like: The LLP Listener and LLP Client, the From Translator and To Translator, etc.

• Dashboard:

  This section covers all about how to use the Dashboard. Here you will find information about: How to use the dashboard, dashboard features, how to manage channels and remote servers, etc.

• Channels:

  This section explains what Channels are, and how you can use and manage them. Here you can find out: What channels are, how to Stop and start channels, how to send and receive HL7 messages, etc.

• Translator:

  Here you will find information about our Translator IDE. In this section you will find things like: IDE features, how you can use the Translator, code annotations and auto-completion, how you can use scripting help, how the version control works, how to use sample data, and much more.

• Logs:

  In this section we explain how you can use and administer the Iguana Logs. For example: Log Features, how you use the logs, how to delete or mark errors, how to resubmit messages from the logs, log configuration and performance, etc.

• Iguana Tips:

  Here you can find various tips that can help you when using Iguana. It includes things like how to monitor plugin output and use regular expression metacharacters.

• HTTP API:

  The HTTP APIs can be called from using the Iguana using the builtin net.http.post/get functions or from any language that supports HTTP POST or GET commands. There are three APIs each of which contains one or more useful Iguana management functions. This section contains a single page describing the HTTP API.

• CDA API:

  Our CDA modules provide a variety of functions and lookup tables for building and customizing CDA documents. The modules also contain extensive auto-completion support to help you develop your code. This section contains a single page describing the CDA API.
  Note: You will probably also want to the check out the CDA: Generate Document  and CDA: Consume Document examples in our builtin Iguana Protocols repository.

• Error Messages:

  This section lists the most common Iguana errors, explains what they mean and identifies Actions to take. The list is not definitive, and is intended to be used as a basis for your own list. This section contains a single page describing common Iguana Error Messages.

• Chameleon:

  Here you can find out how to use Chameleon to manage your VMD files. For example you will learn: How to view a VMD file, how VMD files work, how to create VMD files for ADT messages and Lab messages, and how to add tables and Z segments.

• Iguana Change Log:

  This section is a single page that contains the Iguana Change Log.

Using the Reference Section [top]

You can use the menu to browse to the relevant topic shown in the previous section. Alternatively using search can be very helpful as it will return other relevant content, like: Pages from our Iguana forums, or other related pages from elsewhere in the documentation.

If you cannot find the answer you need please contact us at support@interfaceware.com.