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 screen
|
|
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
|
Downloads a document from Document Manager
|
docid
|
int
|
The ID of the document record to download
|
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
|
|
|
|
Delay
|
int
|
number in milliseconds to wait after processing (good for pausing if making a lot of calls to the same URL)
|
|
Action
|
|
CVSReportID
|
int
|
Launches the system "action" / "report"
|
|
|
|
CUSReportID
|
int
|
Launches the custom "action" / "report"
|
|
|
|
ShowDialog
|
bit
|
If true, and DefaultParams are passed in, it will still show the dialog.
|
|
|
|
ToFile
|
bit
|
If true, the output will be saved to file
|
|
|
|
Filename
|
nvarchar
|
The full path to the file to save
|
|
|
|
ToDocMgt
|
bit
|
if true, the file will be saved to document mgt
|
|
|
|
DocAppId
|
int
|
The Document Applet Type ID (from table DocAppletTypes)
|
|
|
|
doc_KeyId
|
int
|
The relative doc type
|
|
|
|
doc_<AppletName>
|
int
|
Additional columns in the format doc_appletName (from the table DocAppletTypes without the space) where the value is the key. For example, doc_salesjournal with value 1 would associate the document to the Sales Journal SJID 1
|
|
|
|
ToEmail
|
bit
|
if true, the same fields for email can be supplied. Filename can be comma separated
|
|
|
|
param_name
|
string
|
param_ precedes the name of the parameter to pass into the action being run. for example param_projectpath would pass the value in that column into the ^projectpath^ parameter in the action being run.
|
|
|
|
[CUS|CVS]DocTypeId
|
int
|
the primary document type (folder)
|
|
Email
|
|
|
|
|
|
|
|
RecipEmail
|
string
|
the comma separated list of "To's"
|
|
|
|
CC, BCC, Subject, Body
|
string
|
normal email fields
|
|
|
|
FromAddress, FromName
|
string
|
the from info
|
|
|
|
SmtpServer
|
string
|
Optional (defaults to GS)
|
|
|
|
SmtpUser
|
string
|
Optional (defaults to GS)
|
|
|
|
SmtpPass
|
string
|
Optional (defaults to GS)
|
|
|
|
SmtpPort
|
int
|
Optional (defaults to GS)
|
|
|
|
UseSSL
|
bit
|
Optional (defaults to GS)
|
|
|
|
DocId
|
int
|
If supplied, emails the document
|
|
|
|
Filename
|
string
|
comma separated list of file path's to attach
|
|
Power shell
|
Runs powershell script
|
|
|
|
|
|
|
$infocus
|
object
|
The powershell parameter that gets passed in from InFocus
|
|
|
|
.RetErr
|
int
|
Return Number, negative is an error
|
|
|
|
.RetMsg
|
string
|
Return Message
|
|
|
|
.Db
|
SqlConnection
|
SqlConnection (unopened) pointing to InFocus Database
|
|
|
|
.Tx
|
SqlTransaction
|
SqlTransaction if in a transaction pipeline
|
|
|
|
.Error
|
Exception
|
Internal Exception
|
|
|
|
.Username
|
string (readonly)
|
The current InFocus Username
|
|
|
|
.UserId
|
int (readonly)
|
The current InFocus User Id
|
|
|
|
.EmpId
|
int (readonly)
|
The current InFocus Employee Id
|
|
|
|
.EmpCode
|
string (readonly)
|
The current InFocus Employee Code
|
|
|
|
.EmpName
|
string (readonly)
|
The Current InFocus Employee Name
|
|
|
|
.KeyId
|
int
|
The primary key of the current record (if applicable)
|
|
|
|
.AppletName
|
string
|
The name of the executing applet (if applicable)
|
|
|
|
.Dataset
|
Dataset
|
Optional dataset property that will allow reports to be run
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|