REMITT
REMITT Electronic Medical Information Translation and Transmission
Everything
bin/ remitt_cli.pl
bin/ remitt_server.pl
bin/ sqlite_user_admin.pl
Lib
Test

Remitt:: Interface

Contains all methods exported through the XML-RPC interface for Remitt.  It is possible that these methods could also be exported using SOAP (since the SOAP::Lite library is being used to provide XML-RPC functionality).

Functions that require authentication use the <Remitt::Utilities::ForceAuthentication> method from the Remitt::Utilities package.  This uses basic authentication.

Summary
Remitt:: Interface
Contains all methods exported through the XML-RPC interface for Remitt.
Functions
Remitt. Interface. Execute
Execute Render/Translation/Transport series.
Remitt. Interface. FileList
Get list of available files.
Remitt. Interface. GetFile
Retrieve the contents of a file stored in the REMITT spool.
Remitt. Interface. GetStatus
Get status of job identified by unique identifier, as returned by Remitt.Interface.Execute.
Remitt. Interface. ListOptions
Get list of options for a particular plugin.
Remitt. Interface. ListPlugins
Get list of plugins for a particular type
Remitt. Interface. SystemLogin
Start a Remitt session.
Remitt. Interface. SystemLogout
End a Remitt “session”.
Remitt. Interface. ProtocolVersion
Get the current version of the Remitt protocol being used.

Functions

Remitt. Interface. Execute

sub Execute

Execute Render/Translation/Transport series.

Parameters

$inputInput document
$renderName of rendering plugin
$renderoptionName of rendering plugin option
$transportName of transport plugin

Returns

Output from transport plugin if used from the command line interface (CLI), or a unique identifier used to get the actual output from Remitt.Interface.GetStatus.

Example

$x = Remitt.Interface.Execute($xmlfile, ‘XSLT’, ‘837p’, ‘Text’);

Remitt. Interface. FileList

Get list of available files.

Parameters

$categoryCategory of file under the current user.

Returns

Array of files found for the current user and category criteria.

TODO: Needs to work with CLI as well

Remitt. Interface. GetFile

Retrieve the contents of a file stored in the REMITT spool.  This must be executed by a logged in user.

Parameters

$categoryName of the category that the file is in
$fileName of the file

Returns

Contents of the specified file, or NULL if there is an error.

Remitt. Interface. GetStatus

Get status of job identified by unique identifier, as returned by Remitt.Interface.Execute.  This method is not used by the command line interface (CLI) because it does not store state files.

Parameters

$uniqueUnique id key to query about

Returns

Mixed; -1 if incomplete, or the actual contents of the unique identifier status file (usually a file name), or -2 if there is a parameter error.

Remitt. Interface. ListOptions

Get list of options for a particular plugin.

Parameters

$typePlugin type (Render, Translation, Transport, etc)
$pluginPlugin name

Returns

Struct of arrays containing options and information, or empty structure if there are no options.

Remitt. Interface. ListPlugins

Get list of plugins for a particular type

Parameters

$typePlugin type (Render, Translation, Transport, etc)

Returns

Array of plugins for the specified type.

Remitt. Interface. SystemLogin

Start a Remitt session.  This function requires no authentication.

Parameters

$usernameUsername for this account
$passwordPassword for this account

Returns

Struct containing

  • sessionid - Id of session, used as username in basic authentication
  • key - Secret key, used as password in basic authentication

Remitt. Interface. SystemLogout

End a Remitt “session”.  This should only be used when transient data does not need to be kept on the Remitt server.  This function requires authentication.

Remitt. Interface. ProtocolVersion

Get the current version of the Remitt protocol being used.

Returns

Version of the Remitt protocol.
© 2004 by the FreeMED Software Foundation.  Generated by Natural Docs.
sub Execute
Execute Render/Translation/Transport series.
Contains general purpose utility functions necessary for the low-level operation of Remitt.
Get status of job identified by unique identifier, as returned by Remitt.Interface.Execute.