IMS Plugin/Documentation
WikiEditTask (Talk | contribs) m (Auto-upload documentation) |
WikiEditTask (Talk | contribs) m (Auto-upload documentation) |
||
Line 55: | Line 55: | ||
*[[#IMSAddServiceGroup|IMSAddServiceGroup]] — Adds a new ServiceGroup | *[[#IMSAddServiceGroup|IMSAddServiceGroup]] — Adds a new ServiceGroup | ||
*[[#IMSAddSoftwareApplicationGroup|IMSAddSoftwareApplicationGroup]] — Adds a new SoftwareApplicationGroup | *[[#IMSAddSoftwareApplicationGroup|IMSAddSoftwareApplicationGroup]] — Adds a new SoftwareApplicationGroup | ||
+ | *[[#IMSBuildXML|IMSBuildXML]] ( fileName { ; folderPath} ) — Generates and saves XML. | ||
*[[#IMSLastError|IMSLastError]] — Returns the text of the last error triggered by a plugin function. | *[[#IMSLastError|IMSLastError]] — Returns the text of the last error triggered by a plugin function. | ||
*[[#IMSLicenseInfo|IMSLicenseInfo]] — Returns information about the license used. | *[[#IMSLicenseInfo|IMSLicenseInfo]] — Returns information about the license used. | ||
Line 489: | Line 490: | ||
<div class="see"><strong>Returns:</strong> 1 if successful or "ERROR" if an error occurred. | <div class="see"><strong>Returns:</strong> 1 if successful or "ERROR" if an error occurred. | ||
+ | </div> | ||
+ | |||
+ | <div id="IMSBuildXML"></div> | ||
+ | ==IMSBuildXML ( fileName { ; folderPath} ) == | ||
+ | Generates and saves XML. | ||
+ | If you do not supply a folderPath, you may set the result of this plugin funcion to a container field. | ||
+ | Otherwise, the file will be saved to the specified folder path. | ||
+ | |||
+ | <div class="parameters"><strong>Parameters:</strong> | ||
+ | <dl><dt><code>fileName</code> <dd> | ||
+ | <dt><code>folderPath</code> <dd> | ||
+ | </dl></div> | ||
+ | <div class="see"><strong>Returns:</strong> Container data if the save is successful and no folderPath was specified, 1 if saved to disk or "ERROR" if an error occurred. | ||
</div> | </div> | ||
Revision as of 23:33, 25 January 2016
IMS Plugin User Guide
Created by IntelliJ IDEA. User: will Date: 1/22/16 Time: 1:29 PM
360Works Plugin Setup Guides
See Plugins_101 for Error reporting, installation, registration, and more.
Function Summary
- IMSAddAgencyGroup — Adds a new AgencyGroup
- IMSAddCustomGroup ( customElementID ) — Adds a new eCustomConfiguration.
- IMSAddDagency01 ( value ) — Adds a new dAgency.
- IMSAddDagency02 ( value ) — Adds a new dAgency.
- IMSAddDagency04 ( value ) — Adds a new dAgency.
- IMSAddDemographicGroup — Adds a new DemographicGroup
- IMSAddECustomConfiguration — Adds a new eCustomConfiguration
- IMSAddECustomConfiguration01 ( nemsisElement ; value ) — Adds a new eCustomConfiguration.
- IMSAddECustomConfiguration02 ( value ) — Adds a new eCustomConfiguration.
- IMSAddECustomConfiguration03 ( value ) — Adds a new eCustomConfiguration.
- IMSAddECustomConfiguration04 ( value ) — Adds a new eCustomConfiguration.
- IMSAddECustomConfiguration05 ( value ) — Adds a new eCustomConfiguration.
- IMSAddECustomConfiguration06 ( namsisCode ; customValueDescription ; value ) — Adds a new eCustomConfiguration.
- IMSAddECustomConfiguration07 ( value ) — Adds a new eCustomConfiguration.
- IMSAddECustomConfiguration08 ( value ) — Adds a new eCustomConfiguration.
- IMSAddECustomConfiguration09 ( value ) — Adds a new eCustomConfiguration.
- IMSAddERecord — Adds a new eRecord
- IMSAddERecord01 ( value ) — Adds a new eRecord.
- IMSAddERecord02 ( value ) — Adds a new eRecord.
- IMSAddERecord03 ( value ) — Adds a new eRecord.
- IMSAddERecord04 ( value ) — Adds a new eRecord.
- IMSAddEResponse — Adds a new eResponse
- IMSAddEResponse01 ( value ) — Adds a new eResponse01
- IMSAddEResponse02 ( NV ; value ) — Adds a new eResponse02
- IMSAddEResponse03 ( NV ; value ) — Adds a new eResponse03
- IMSAddEResponse05 ( value ) — Adds a new eResponse05
- IMSAddEResponse05 ( NV ; correlationID ; value ) — Adds a new eResponse08
- IMSAddEResponse06 ( value ) — Adds a new eResponse06
- IMSAddEResponse07 ( value ) — Adds a new eResponse07
- IMSAddEResponse09 ( NV ; correlationID ; value ) — Adds a new eResponse09
- IMSAddEResponse10 ( NV ; correlationID ; value ) — Adds a new eResponse10
- IMSAddEResponse11 ( NV ; correlationID ; value ) — Adds a new eResponse11
- IMSAddEResponse12 ( NV ; correlationID ; value ) — Adds a new eResponse12
- IMSAddEResponse13 ( value ) — Adds a new eResponse13
- IMSAddEResponse14 ( value ) — Adds a new eResponse14
- IMSAddEResponse15 ( value ) — Adds a new eResponse15
- IMSAddEResponse16 ( value ) — Adds a new eResponse16
- IMSAddEResponse17 ( value ) — Adds a new eResponse17
- IMSAddEResponse18 ( value ) — Adds a new eResponse18
- IMSAddEResponse19 ( value ) — Adds a new eResponse19
- IMSAddEstate — Adds a new eState
- IMSAddEstate01 ( timestamp ; value ) — Adds a new eState.
- IMSAddHeader — Adds a new Header
- IMSAddPatientCareReport — Adds a new PatientCareReport
- IMSAddServiceGroup — Adds a new ServiceGroup
- IMSAddSoftwareApplicationGroup — Adds a new SoftwareApplicationGroup
- IMSBuildXML ( fileName { ; folderPath} ) — Generates and saves XML.
- IMSLastError — Returns the text of the last error triggered by a plugin function.
- IMSLicenseInfo — Returns information about the license used.
- IMSNewDataSet — Creates a new EMSDataSet
- IMSRegister ( licenseKey ; registeredTo ) — Registers the IMS Plugin.
- IMSSetErrorCapture ( errorCapture ) — Toggles error dialogs on or off.
- IMSVersion — Returns the version of the IMS plugin which is installed.
Function Detail
IMSAddAgencyGroup
Adds a new AgencyGroup
IMSAddCustomGroup ( customElementID )
Adds a new eCustomConfiguration.CustomGroup
IMSAddDagency01 ( value )
Adds a new dAgency.01
IMSAddDagency02 ( value )
Adds a new dAgency.02
IMSAddDagency04 ( value )
Adds a new dAgency.04
IMSAddDemographicGroup
Adds a new DemographicGroup
IMSAddECustomConfiguration
Adds a new eCustomConfiguration
IMSAddECustomConfiguration01 ( nemsisElement ; value )
Adds a new eCustomConfiguration.01
IMSAddECustomConfiguration02 ( value )
Adds a new eCustomConfiguration.02
IMSAddECustomConfiguration03 ( value )
Adds a new eCustomConfiguration.03
value
IMSAddECustomConfiguration04 ( value )
Adds a new eCustomConfiguration.04
IMSAddECustomConfiguration05 ( value )
Adds a new eCustomConfiguration.05
IMSAddECustomConfiguration06 ( namsisCode ; customValueDescription ; value )
Adds a new eCustomConfiguration.06
IMSAddECustomConfiguration07 ( value )
Adds a new eCustomConfiguration.07
IMSAddECustomConfiguration08 ( value )
Adds a new eCustomConfiguration.08
IMSAddECustomConfiguration09 ( value )
Adds a new eCustomConfiguration.09
IMSAddERecord
Adds a new eRecord
IMSAddERecord01 ( value )
Adds a new eRecord.01
IMSAddERecord02 ( value )
Adds a new eRecord.02
value
IMSAddERecord03 ( value )
Adds a new eRecord.03
value
IMSAddERecord04 ( value )
Adds a new eRecord.04
value
IMSAddEResponse
Adds a new eResponse
IMSAddEResponse01 ( value )
Adds a new eResponse01
value
IMSAddEResponse02 ( NV ; value )
Adds a new eResponse02
NV
value
IMSAddEResponse03 ( NV ; value )
Adds a new eResponse03
NV
value
IMSAddEResponse05 ( value )
Adds a new eResponse05
value
IMSAddEResponse05 ( NV ; correlationID ; value )
Adds a new eResponse08
NV
correlationID
value
IMSAddEResponse06 ( value )
Adds a new eResponse06
value
IMSAddEResponse07 ( value )
Adds a new eResponse07
value
IMSAddEResponse09 ( NV ; correlationID ; value )
Adds a new eResponse09
NV
correlationID
value
IMSAddEResponse10 ( NV ; correlationID ; value )
Adds a new eResponse10
NV
correlationID
value
IMSAddEResponse11 ( NV ; correlationID ; value )
Adds a new eResponse11
NV
correlationID
value
IMSAddEResponse12 ( NV ; correlationID ; value )
Adds a new eResponse12
NV
correlationID
value
IMSAddEResponse13 ( value )
Adds a new eResponse13
value
IMSAddEResponse14 ( value )
Adds a new eResponse14
value
IMSAddEResponse15 ( value )
Adds a new eResponse15
value
IMSAddEResponse16 ( value )
Adds a new eResponse16
value
IMSAddEResponse17 ( value )
Adds a new eResponse17
value
IMSAddEResponse18 ( value )
Adds a new eResponse18
value
IMSAddEResponse19 ( value )
Adds a new eResponse19
value
IMSAddEstate
Adds a new eState
IMSAddEstate01 ( timestamp ; value )
Adds a new eState.01
IMSAddHeader
Adds a new Header
IMSAddPatientCareReport
Adds a new PatientCareReport
IMSAddServiceGroup
Adds a new ServiceGroup
IMSAddSoftwareApplicationGroup
Adds a new SoftwareApplicationGroup
IMSBuildXML ( fileName { ; folderPath} )
Generates and saves XML. If you do not supply a folderPath, you may set the result of this plugin funcion to a container field. Otherwise, the file will be saved to the specified folder path.
fileName
folderPath
IMSLastError
Returns the text of the last error triggered by a plugin function. This should be called immediately after a plugin function returns "ERROR" to get a description of the error.
""
if there was no error.
IMSLicenseInfo
Returns information about the license used.
IMSNewDataSet
Creates a new EMSDataSet
IMSRegister ( licenseKey ; registeredTo )
Registers the IMS Plugin.
licenseKey
- a valid license key string, or the literal string "DEMO" to run in demo mode.
registeredTo
- the company name for the license key used.
IMSSetErrorCapture ( errorCapture )
Toggles error dialogs on or off. When something unexpected happens, the plug-in will pop up a dialog displaying the error message. This makes it easy to see what went wrong. However, in some cases, you (the developer) may prefer to show your own message to the user, or possibly not show a message at all. In that case, you can call EmailSetErrorCapture with a parameter of true. That will suppress the error dialog from appearing to the user.
errorCapture
- set to true to suppress the default popups.
IMSVersion
Returns the version of the IMS plugin which is installed.