IGDACExportLIMS

Email Email | Print Print

Overview

The IGDACExportLIMS interface allows users to export data from the LIMS or GCOS system to a MAGE-ML compliant file.

COM Attributes

Attribute
Type/Supported
Threading model
Both
Interface
Dual
Aggregation
Yes
ISupportErrorInfo
Yes
Connection Points
No
Free Threading Marshaler
No


Properties

Name
ID
1
Description
Name of item to be exported.
Type
BSTR
Length
64 characters
Access
Read-Write
Remarks
Returns error if setting invalid file name characters: \/:;*?"<>|'`,{}[]
The NameType property must be set to identify the meaning of the Name.


NameType
ID
2
Description
Defines the meaning of the Name property.
Type
Access
Read-Write
Remarks
Required Property


ExportData
ID
3
Description
Type of data to be exported to MAGE-ML.
Type
long (combination of EXPORT_DATA enums)
Access
Read-Write
Remarks
Enumerant values may be combined using the bitwise OR operator to specify more than one type of data to export.


ExportBaselineData
ID
4
Description
Export the CHP baseline file data.
Type
BOOL
Access
Read-Write
Remarks
TRUE= export CHP baseline file data.
FALSE=refer to the CHP baseline file but don't export its data.
Applies only if a CHP file is exported.


OutputFile
ID
5
Description
Full file name (including path) to which the MAGE-ML output shall be written.
Type
BSTR
Length
260 characters including path and file extension.
Access
Read-Write
Remarks
Returns error if name includes invalid characters: \/:;*?"<>|'`,{}[]

If the output file name extension does not have the XML extension it shall be added.



ServerName
ID
6
Description
LIMS server, GCOS client or GCOS server name.
Type
BSTR
Length
260 characters.
Access
Read-Write
Remarks
This property must be set.


NTUserName
ID
7
Description
The login NT user name for security purposes.
Type
BSTR
Access
Read-Write
Remarks
This property must be set.


UserNameFilter
ID
8
Description
Filter property. Specifies the name of the user that created the items to be exported.
Type
BSTR
Length
64 characters.
Access
Read-Write
Remarks
The exported items shall meet all the filter criteria.


ProjectNameFilter
ID
9
Description
Filter property. Specifies the project to which the exported items must belong to.
Type
BSTR
Length
64 characters.
Access
Read-Write
Remarks
The exported items shall meet all the filter criteria.


ProbeArrayTypeFilter
ID
10
Description
Filter property. Specifies the probe array type from which the exported items shall be derived.
Type
BSTR
Length
64 characters.
Access
Read-Write
Remarks
The exported items shall meet all the filter criteria.


UpperDateFilter
ID
11
Description
Filter property. Exported items shall have a date that is on or before the UpperDate.
Type
BSTR
Format
YYYY-MM-DD
Access
Read-Write
Remarks
The exported items shall meet all the filter criteria.


LowerDateFilter
ID
12
Description
Filter property. Exported items shall have a date that is on or after the LowerDate.
Type
BSTR
Format
YYYY-MM-DD
Access
Read-Write
Remarks
The exported items shall meet all the filter criteria.


AuthorityName
ID
15
Description
An identifier of the user creating the MAGE-ML documents.
Type
BSTR
Access
Read-Write
Remarks
The default name is the name of the workstation where the export tool is executed.



Methods

Export
ID
13
Description
This function shall create the MAGE-ML output file based on the interface property settings.
Prototype
HRESULT Export()
Parameters
N/A
Return
HRESULT - S_OK if successful, E_FAIL otherwise.
Remarks
Name, NameType, ServerName and NTUserName are required to be set prior to calling this method.


Back to Top >