-
activateCategory(categoryName)
-
Activates a category. If the user does not have the appropriate rights on the category, an exception is thrown.
Parameters:
| Name |
Type |
Description |
categoryName |
string
|
|
- Source:
-
-
<protected> afterExecute()
-
- Source:
-
-
<protected> asJsonRpc()
-
- Source:
-
-
clearDetail(detail)
-
Clears all relations for the specified detail
Parameters:
| Name |
Type |
Description |
detail |
string
|
The detail name, e.g. "Comp" |
- Source:
-
-
closeContext()
-
Closes the context and frees the memory on the web server.
- Source:
-
-
closingCommit()
-
Commits the changes, releases the record and executes closeContext
- Source:
-
-
commitChanges()
-
Commits the changes to the database.
- Source:
-
-
copyFromExisting(key [, minTableView] [, maxTableView])
-
Copies data from an existing record in the database. The same entity as the current is assumed.
The table views within the index range minIndex to maxIndex are copied. By default, all table views are copied.
To copy a single detail, obtain the table view index using IndexFromDetail and use this value as MinIndex and MaxIndex.
Parameters:
| Name |
Type |
Argument |
Default |
Description |
key |
number
|
|
|
The key of the source record. |
minTableView |
number
|
<optional>
|
0
|
The index of first table view to be copied. |
maxTableView |
number
|
<optional>
|
999
|
The index of last table view to be copied. |
- Source:
-
-
deleteDetail(detail, detailKey)
-
Deletes a detail relation
Parameters:
| Name |
Type |
Description |
detail |
string
|
The detail name, e.g. "Comp" |
detailKey |
number
|
string
|
The key of the detail |
- Source:
-
-
getAttachment(k_file [, version])
-
Request attachment from FILES table
Parameters:
| Name |
Type |
Argument |
Default |
Description |
k_file |
number
|
|
|
|
version |
number
|
<optional>
|
0
|
|
- Source:
-
Returns:
-
Type
-
AttachmentObject
-
getCategoryDataSet(categoryName)
-
Retrieves the DataSet for category categoryName. Can be null when the category is not available to the current user.
Parameters:
| Name |
Type |
Description |
categoryName |
string
|
name of the category, e.g. "DOCU$INVOICING" |
- Source:
-
Returns:
-
Type
-
DataSetObject
-
getDetailDataSet(detail [, filter] [, includeBlobContent])
-
Retrieves a relation DataSet for the specified detail in the edit context.
Parameters:
| Name |
Type |
Argument |
Default |
Description |
detail |
string
|
|
|
The detail name, e.g. "Comp" |
filter |
string
|
<optional>
|
""
|
SQL filter expression, e.g. "COMMENT like '%template%'" |
includeBlobContent |
boolean
|
<optional>
|
false
|
If true, blob fields (e.g. memo, stream) are returned |
- Source:
-
Returns:
-
Type
-
DataSetObject
-
getMasterDataSet()
-
Retrieves a master DataSet from the edit context.
- Source:
-
Returns:
-
Type
-
DataSetObject
-
insertAttachment(attachedFileType, path)
-
Inserts an file
Parameters:
| Name |
Type |
Description |
attachedFileType |
number
|
1 = embedded, 2 = linked, 4 = remote, 5 = large |
path |
string
|
The path of the file that will be saved in the FILES.PATH field. |
- Source:
-
-
insertDetail(detail, detailKey [, linkMainCompany] [, retrieveName])
-
Inserts a detail relation
Parameters:
| Name |
Type |
Argument |
Default |
Description |
detail |
string
|
|
|
The detail name, e.g. "Comp" |
detailKey |
number
|
|
|
The key of the detail |
linkMainCompany |
boolean
|
<optional>
|
false
|
|
retrieveName |
boolean
|
<optional>
|
false
|
|
- Source:
-
-
setReference(id)
-
Requests that a unique reference number be generated when committing.
Parameters:
| Name |
Type |
Description |
id |
number
|
SYS_REFERENCES.K_REFERENCE |
- Source:
-
-
setUsers(users [, clear])
-
Sets the user relations.
Parameters:
| Name |
Type |
Argument |
Default |
Description |
users |
array
|
|
|
The array of user IDs (keys). |
clear |
boolean
|
<optional>
|
false
|
If true, clears the current user selection. |
- Source:
-
-
setUserSecurity(account, securityValue)
-
Sets the security for a user or group.
Parameters:
| Name |
Type |
Description |
account |
number
|
The user or group for which security is added. |
securityValue |
number
|
A sum of one or more of the following values: 1 (search), 2 (read), 4 (write), 8 (delete) and 256 (secure). Useful combinations are 7 (read/write), 15 (read/write/delete) and 271 (full control = read/write/delete/secure). |
- Source:
-
-
updateAttachment(key, base64String)
-
Updates an embedded file
Parameters:
| Name |
Type |
Default |
Description |
key |
number
|
0
|
Leave null or 0 to set the stream of the just inserted Attachment |
base64String |
string
|
|
|
- Source:
-
-
updateCategoryField(categoryName, name, value)
-
Updates the value of a field of any type in a category data set
Parameters:
| Name |
Type |
Description |
categoryName |
string
|
|
name |
string
|
|
value |
string
|
number
|
|
- Source:
-
-
updateCategoryFields(categoryName, fieldsObj)
-
Updates the value of a field of any type in a category data set
Parameters:
| Name |
Type |
Description |
categoryName |
string
|
|
fieldsObj |
object
|
e.g. {"OPENED": "0"} |
- Source:
-
-
updateDetail(detail, detailKey, fieldsObj,)
-
Updates field values of a detail relation. When the detail relation doesn't exist, an exception is thrown.
Parameters:
| Name |
Type |
Description |
detail |
string
|
The detail name, e.g. "Comp" |
detailKey |
number
|
string
|
The key of the detail. If detailKey is 0, the current detail record is used |
fieldsObj, |
object
|
e.g. {"OPENED": "0"} |
- Source:
-
-
updateField(name, value)
-
Updates the field values of a master data set
Parameters:
| Name |
Type |
Description |
name |
string
|
|
value |
string
|
number
|
|
- Source:
-
-
updateFields(fieldsObj)
-
Updates the field values of a master data set.
Parameters:
| Name |
Type |
Description |
fieldsObj |
object
|
e.g. {"OPENED": "0"} |
- Source:
-