Getting Started Utilities>Custom Reports

Top  Previous  Next

Key Concepts

 

Return Types

 

Actions trigger system responses to a defined list of Return Types. An Action can return zero or more return type result sets. If more than one return type is returned, the system will respond to each item in the order returned. Below is a listing of each Return Type, the response it triggers and allowable fields (data types, and field descriptions) to call.

 

Return Type

Description

Fields

Data Types

Field Description

Additional Information

Message

Displays a message box on the screen

reterr

numeric

Greater than 0=Success, Less than 0=Error




retmsg

nvarchar

The message to display on sreen


Applet

Opens an InFocus Applet

appletname

nvarchar

The name of the applet to open

Chart of Accounts, Clients, Disbursement Journal, Employee Reimbursables, Employees, General Journal, Projects, Project Planning, Purchase Journal, Receipt Journal, Sales Journal, Time Sheet, Vendors, Expense Sheets, Timesheet Adjustments



keyid

int

The ID of the record to load in the respective applet


DocID

Dowloads a document from Document Manager

docid

int

The ID of the docuement record to downloda

Please note, this return type bypasses defined permissions set on the document(s).

Web Call

Makes a call to the web

BrowserWidth

int

If opening a browser, this sets the width




BrowserHeight

int

If opening a browser, this sets the width




Content

nvarchar

The override data to post to the weburl




ContentType

nvarchar

The content type header (default is application/x-www-form-urlencoded)




Debug

bit

When true, the response will be added to the InFocus SQL Watcher




FilePath

nvarchar

For uploading files. If set, this will automatically set the method to post and the contenttype to multipart/form-data




Format

nvarchar

Format to utilize in the web call

Allowed formats are: FORM, JSON, or XML (default is FORM)



IncludeParams

bit

When true, the parameters from the Action will be posted in the format specified




IsDocManagement

bit

When true, and a file is being uploaded, it will also post the necessary fields for the listening Document Management service




Method

nvarchar

Method to utilize in the web call

For example: GET, POST, PUT,HEAD, etc. The default is GET



OpenURL

nvarchar

Opens a browser to the specified URL




ParamQuerystring

bit

If true, the included parameters will be appended to the url as a query string




Password

nvarchar

The password for basic authentication




ResponseProcedure

nvarchar

If specified, the web response is passed to the procedure specified in a variable called @response nvarchar(max)




ShowResponse

bit

If true, the response will be shown in a browser window




URL

nvarchar

The URL to be called




UseBasicAuth

bit

If true, the basic authentication header will be added.

Username and Password must be present



Username

nvarchar

The username for basic authentication