Export an ELN or LES Worksheet
This action offers similar options to what is described in the Product Documentation when a user chooses to publish a worksheet.

worksheetid

Identifier of the worksheet. Accepts a semicolon separated list. If multiple values are supplied, each worksheet will be published separately to your specified destination.

Yes

worksheetversionid

Version identifier of the worksheet. Accepts a semicolon separated list. Each worksheet version will be published separately to your specified destination.

Yes

destination

Destination for the export. Valid values are: file, email, printer, and sdi.

Yes

destination_file

Possible value for PROPERTY_DESTINATION property. For example, your code might include: props.setProperty( PROPERTY_DESTINATION, PROPERTY_DESTINATION_FILE )

destination_email

Possible value for PROPERTY_DESTINATION property. For example, your code might include: props.setProperty( PROPERTY_DESTINATION, PROPERTY_DESTINATION_EMAIL )

destination_printer

Possible value for PROPERTY_DESTINATION property. For example, your code might include: props.setProperty( PROPERTY_DESTINATION, PROPERTY_DESTINATION_PRINTER )

destination_sdi

Possible value for PROPERTY_DESTINATION property. For example, your code might include: props.setProperty( PROPERTY_DESTINATION, PROPERTY_DESTINATION_SDI )

filetype

Format for the export. Valid values are: word and pdf.

Yes

filetype_word

Possible value for PROPERTY_FILETYPE property. For example, your code might include: props.setProperty( PROPERTY_FILETYPE, PROPERTY_FILETYPE_WORD )

filetype_pdf

Possible value for PROPERTY_FILETYPE property. For example, your code might include: props.setProperty( PROPERTY_FILETYPE, PROPERTY_FILETYPE_PDF )

filename

Destination filename for the export. This may be used by email, file or attachment destinations. When exporting to file, this filename should include the path. The path must be a valid destination as defined in your FileLocationPolicy.

Note: When exporting multiple worksheets, each export will require its own filename. This can be done in one of three ways:

1. Provide a semi-colon list of fully qualified filenames - one for each worksheet
2. Provide a single filename with [worksheetid], [worksheetversionid] or [worksheetname] substitution in the filename
3. Provide a single filename. After the first export, subsequent files will receive a _1, _2, _3 etc suffix

Note: ${worksheetid}, ${worksheetversionid} and ${worksheetname} substitution is also supported. This may be useful if calling the action from a listpage - where the [worksheetid] property value gets substituted by the list prior to calling the action

Yes

emailfrom

Email addresses to which the recipient can reply.

Only if the destination is email.

emailtolist

Email addresses to which the report is sent.

Only if the destination is email.

emailcclist

List of recipients copied on the email.

No

emailsubject

Email "Subject" (text description of email).

No

emailmessage

Email message to include with the Report.

No

addressid

Identifier of an Address SDI that specifies the target printer.

Only if the destination is printer.

If you want to send the report to a printer, you must enter the identifier of an Address SDI that specifies the target printer. In this case, you must also specify an addresstype.

addresstype

Address Type for the SDI identified by addressid.

Only if you specify an addressid.

sdisdcid

Destination SDI for the export - sdcid. Using this approach, the worksheet exported to PDF or Word will become an attachment to an SDI in this SDC.

Only if the destination is sdi.

sdikeyid1

Destination SDI for the export - keyid1

Only if the destination is sdi.

sdikeyid2

Destination SDI for the export - keyid2

Only when the destination SDC uses multiple columns to form the unique identifier for for SDIs in this SDC.

sdikeyid3

Destination SDI for the export - keyid3

Only when the destination SDC uses more than two columns to form the unique identifier for for SDIs in this SDC.

sdiattachmentdesc

Attachment description for file attached to SDI

Only if the destination is sdi.

sdiattachmentbyref

Determines if the exported file will be a reference attachment to an SDI or if it is uploaded and stored in an attachment repository.

Only if the destination is sdi.

Set to Y if the attachment to the sdi will be unmanaged by LabVantage.
IMPORTANT: If attaching by reference, you must provide a fully qualified filename - likely pointing to a shared network drive Set to N if the attachment will be processed by LabVantage and copied into a repository from which the SDI will retrieve the file on demand.

pagesize

Pagesize override for the export. Valid values are:

• letter
• legal
• a4
• a5
• b5

No

pagesize_letter

Possible value for PROPERTY_PAGESIZE property. For example, your code might include: props.setProperty( PROPERTY_PAGESIZE, PROPERTY_PAGESIZE_LETTER )

pagesize_legal

Possible value for PROPERTY_PAGESIZE property. For example, your code might include: props.setProperty( PROPERTY_PAGESIZE, PROPERTY_PAGESIZE_LEGAL )

pagesize_a4

Possible value for PROPERTY_PAGESIZE property. For example, your code might include: props.setProperty( PROPERTY_PAGESIZE, PROPERTY_PAGESIZE_A4 )

pagesize_a5

Possible value for PROPERTY_PAGESIZE property. For example, your code might include: props.setProperty( PROPERTY_PAGESIZE, PROPERTY_PAGESIZE_A5 )

pagesize_b5

Possible value for PROPERTY_PAGESIZE property. For example, your code might include: props.setProperty( PROPERTY_PAGESIZE, PROPERTY_PAGESIZE_B5 )

orientation

Orientation override for the export. Valid values are:

• portrait
• landscape

No

orientation_portrait

Possible value for PROPERTY_ORIENTATION property. For example, your code might include: props.setProperty( PROPERTY_ORIENTATION, PROPERTY_ORIENTATION_PORTRAIT )

orientation_landscape

Possible value for PROPERTY_ORIENTATION property. For example, your code might include: props.setProperty( PROPERTY_ORIENTATION, PROPERTY_ORIENTATION_LANDSCAPE )

shownotes

Show notes override for the export. Set to "Y" to include Notes that were added to controls. Set to "N" to exclude these notes from the publication.

No

showimagemarkup

Show image markup override for the export. Set to "Y" if images included in any file controls on the worksheet have been marked up and those markups should be published.

No

showmetadata

Show metadata override for the export. Set to "Y" if metadata (Attributes) addeds to the worksheet controls should be included in the publication.

No

When a property has a fixed set of possible values, you can code your calls to this action by setting properties.
In Java, the setProperty method uses (String key,String value). For example, you could write:
props.setProperty( PROPERTY_DESTINATION, "file" )
or, you could write:
props.setProperty( PROPERTY_DESTINATION, PROPERTY_DESTINATION_FILE )
...which also sets the String value to "file".
The second approach offers more flexibility in case the text, 'file', needs to be replaced with different text in the future which theoretically will mean the same thing.