Dashboard and AAS parameter syntax

The following items describe the syntax for the parameter elements that can be used for AAS (ActivityHD Automation Services) and dashboard actions. Descriptions are written in pseudo XML syntax.

Pseudo XML syntax

@Name - an xml attribute named 'Name', valid xml would be Name='Value'

@Name(Value1/Value2/…) - an xml attribute named 'Name' with a list of the valid values

(n) - indicates that the element can be repeated

Open and Show List

<Filter @Name @Type(Personal/Shared/Built-In)><Parameter @Name @Value/@Code/@ID/@Expression/>(n)</Filter>(n)

<IncludeObsolete @Value/>

<IncludeCanceled @Value/>

<Lookup @Value/>

GL Financial Views only:

<CurrentPeriod>

<Calendar @Value/>

<Expression @Value/>

<Year @Value/>

<Period @Value/>

<PeriodContains @Value/@Expression/>

</CurrentPeriod>

<IncludeUnmergedEntries @Value/>

PR Leave Ledger Balances only:

<BeginDate @Value/@Expression/>

<EndDate @Value/@Expression/>

Actions that begin with Find

<Item @Code/@ID>

<Find>

<Filter @Name @Type(Personal/Shared/Built-In)><Parameter @Name @Value/@Code/@ID/@Expression/>(n)</Filter>(n)

<IncludeObsolete @Value/>

<IncludeCanceled @Value/>

<Lookup @Value/>

</Find>

Count macro

<Filter @Name @Type(Personal/Shared/Built-In)><Parameter @Name @Value/@Code/@ID/@Expression/>(n)</Filter>(n)

<IncludeObsolete @Value/>

<IncludeCanceled @Value/>

Processes with steps

<Step @Name> ... </Step>(n)

Dialogs with saved answers

<Answer @Name @Type(Personal/Shared)/>

<Answer><DialogAnswers .../><SelectionAnswers .../></Answer>

Set Form Options

Sample dashboard gadget:

<<action

package: "Purchasing"

folder: "Orders"

action: "Edit"

parameters: "

<p>

<Item Code='07662'/>

<Options><Answers Name='Test'/></Options>

<ShowList><IncludeCanceled Value='True'/></ShowList>

</p>"

>>

Reports - Using Crystal Reports designs

See "Reports - Using Financial Report Designs with Excel" below for the proper syntax to use with Print Financial Statements and Publish Financial Report. In particular, @FormatType has different options for Crystal Report designs versus financial designs.

<ShowForm/> - show the report dialog form

<Close/> - close the report dialog form and stop any further actions

<Answer @Name @Type(Personal/Shared)/>

<Answer><DialogAnswers .../><SelectionAnswers .../></Answer>

<CheckData/> - if no data will be shown in the report then stop any further actions

<Preview/>

<Print/>

@Prompt(True/False)/> - defaults to False

@Copies

@Collate(True/False)

@Duplex(Default/Simplex/Vertical/Horizontal)

@PrinterName

@PrintToFile(True/False)

@PrintFilePrompt(True/False)

@PrintFileName

@PrintRange(AllPages/Selection/SomePages/CurrentPage)

@FromPage

@ToPage/>

<Email

@Prompt(True/False) - defaults to False when run with no report dialog; otherwise, defaults to True

@UseTags(True/False)

@SeparatePages(True/False)

@ToAddress

@CCAddress

@BCCAddress

@Subject>

<Attachment

@Name - defaults to name of the file from @Path

@Path/>(n)

<Body>...</Body>(n)

</Email>

<EmailTo - available for a limited number of reports, like Email to Employees on the Payroll Pay Statements Report

@Interactive(True/False) - defaults to False

@Prompt(True/False) - defaults to False if at least one email address is specified

@CCAddress

@BCCAddress

@Subject>

<BodyText>...</BodyText>

</EmailTo>

<Export

@Prompt(True/False) - defaults to False, if True all other options are ignored

@FormatType2(NoFormat/CrystalReport/RichText/CharacterSeparatedValues/Text/TabSeparatedText/WordForWindows/Excel/HTML32/ExcelRecord/PortableDocFormat/HTML40/EditableRTF/Xml/FlatFile)

@DestinationType(NoDestination/DiskFile/MicrosoftMail/MicrosoftExchange)

@ExchangeProfile

@DiskFilePrompt(True/False)

@DiskFileName

@UseReportDateFormat(True/False)

@UseReportNumberFormat(True/False)

@CharFieldDelimiter

@CharStringDelimiter

@HTMLFilePrompt(True/False)

@HTMLFileName

@ExchangePassword

@ExchangeDestinationType(ExchangePostDocMessage)

@ExchangeFolderPath

@MailUserName

@MailPassword

@MailToList

@MailCcList

@MailSubject

@MailMessage

@ExcelTabHasColumnHeadings(True/False)

@ExcelUseWorksheetFunctions(True/False)

@ExcelUseConstantColumnWidth(True/False)

@ExcelConstantColumnWidth

@ExcelAreaType(ReportHeader/PageHeader/GroupHeader/Detail/GroupFooter/PageFooter/ReportFooter/WholeReport)

@ExcelAreaGroupNumber

@ExcelShowGridLines(True/False)

@ExcelPageBreaks(True/False)

@ExcelConvertDateToString(True/False)

@ExcelUsePageRange(True/False)

@ExcelFirstPageNumber

@ExcelLastPageNumber

@HTMLEnableSeparatedPages(True/False)

@HTMLHasPageNavigator(True/False)

@PDFUsePageRange(True/False)

@PDFFirstPageNumber

@PDFLastPageNumber

@RTFUsePageRange(True/False)

@RTFFirstPageNumber

@RTFLastPageNumber

@XMLExportSelection

@WORDWUsePageRange(True/False)

@WORDWFirstPageNumber

@WORDWLastPageNumber/>

<Attach - available for a limited number of reports, like Attach on the Payroll Pay Statements Report

@Interactive(True/False) - defaults to False

@ConflictResponse(New/Replace/Cancel)/> - defaults to New

Example of Email Parameters

Set activity = CreateObject("ActivityOAS.Activity")

activity.SendEmail _

"<Email ToAddress='[email protected]' Subject='Some reports you need'>" + _

"<Attachment Path='C:\Temp\Report1.pdf'/>" + _

"<Attachment Path='C:\Temp\Report2.pdf'/>" + _

"<Body>Here are the reports you need.</Body>" + _

"</Email>"

Reports - Using Financial Report Designs with Excel

The following code sample applies to Print Financials and Publish Financial Report. Notice that the @FormatType options for financial designs differ from the options for Crystal Reports designs which are discussed above in "Reports - Using Crystal Reports designs".

<Print/>

@Prompt(True/False)/> - defaults to False

@Copies

@Collate(True/False)

@Duplex(Default/Simplex/Vertical/Horizontal)

@PrinterName

@PrintToFile(True/False)

@PrintFilePrompt(True/False)

@PrintFileName

@PrintRange(AllPages/Selection/SomePages)

@FromPage

@ToPage/>

<Export

@Prompt(True/False) - defaults to False, if True all other options are ignored

@FormatType(OpenXMLWorkbook/OpenXMLWorkbookMacroEnabled/Excel12/Excel8/WebArchive/Html/

  OpenXMLTemplate/OpenXMLTemplateMacroEnabled/Template8/Text/UnicodeText/XMLSpreadsheet/

  Excel5/CSV/TextPrinter/TextMac/TextMSDOS/CS/CSVMac/CSVMSDOS/DIF/SYLK/OpenXMLAddIn/PDF/

  OpenDocumentSpreadsheet)

@DiskFilePrompt(True/False)

@DiskFileName/>

Export

<Export @File/>

Import

<Import @File @XPath/>

Export/Import syntax with @Content and @Command

Copy snippet

<xml @Content(Complete, List)>
    <data @Command(Import, New, Edit, Delete)>
        <ReferenceList @Command(Clear)>
            <item @Value @ValueInternal @Command(Add, Remove)/>
        </ReferenceList>
        <Detail @Command(Delete All)>
            <data @Line @Command(Append, Insert, Edit, Delete, Delete All)/>
        </Detail>
        <Attachments @Content(Complete, List) @Command(DeleteAll)>
            <item @FileName @Command(Add, Delete)/>
        </Attachments>
    </data>
</xml>

MyLocation

<Favorite @Value/>

<Location @Value @Out(True/False) @Personal(True/False)/>

INavigator.Parameters

<Filter @Name @Type(Personal/Shared/Built-In)><Parameter @Name @Value/@Code/@ID/@Expression/>(n)</Filter>(n)

<IncludeObsolete @Value/>

<IncludeCanceled @Value/>

<Column @Name @Sort(Ascending/Descending)/>

SendEmail

<Email

@Prompt(True/False) - defaults to False when run with no report dialog; otherwise, defaults to True

@UseTags(True/False)

@From(MAPI/Windows user default account/Server personal/Server generic) - "MAPI" and "Windows user default account" are synonymous

@ToAddress

@CCAddress

@BCCAddress

@ReceiptRequest(True/False)

@Subject>

<Attachment

@Name - defaults to the name of the file from @Path

@Path/>

<Body>...</Body>(n)

<HTML>...</HTML>(n)

</Email>

Example