Difference between revisions of "Add Journal"
(Created page with "Category:Resource_Functions {{HelpFiles}} ====addJournal==== Adds a journal to a resource, the created date is the current date. '''Syntax''' addJournal(''resour...") |
|||
(One intermediate revision by the same user not shown) | |||
Line 1: | Line 1: | ||
[[Category:Resource_Functions]] | [[Category:Resource_Functions]] | ||
− | + | [Obsolete - Please use [[ResourceJournalEntry_class|ResourceJournalEntry]]. More detail at [[ConversionMethods|ConversionMethods]] ] | |
====addJournal==== | ====addJournal==== |
Latest revision as of 03:30, 13 May 2022
[Obsolete - Please use ResourceJournalEntry. More detail at ConversionMethods ]
addJournal
Adds a journal to a resource, the created date is the current date.
Syntax
addJournal(resourceUniqueId, userId, type, content)
Return type
Boolean
If function returns "False" then the Function has tried to add a type of journal comment to a resource type that does not accept that comment type.
If function returns "True" then Function updated journal as requested with no validation errors.
Arguments
resourceUniqueId: Is a numeric (non-decimal) expression. It is the UniqueId of a resource.
userId: Is a numeric (non-decimal) expression. It is the id of a user.
type: Is a string expression. It is a comment type. It must have one of these values:
- “Description”
- “Proposal”
- “Comment”
- “Reassignment”
- “Outcome”
- “Disapproval”
- “Cancellation”
- “Rejection”
- “NotAcceptRejection”
- “Acceptance”
- “Approval”
- “Mergence”
- “UndoComplete”
content: Is a string expression. It is the content of the journal.
Notes: using addJournal on tasks will change their status in some cases:
Comment type |
Task status |
Other |
Acceptance |
InProgress |
The task has been accepted by the user specified |
Approval |
Approved |
The task has been approved by the user specified |
Cancellation |
Cancelled |
The task has been canceled by the user specified |
Disapproval |
InProgress |
The task has been disapproved by the user specified |
NotAcceptRejection |
NeedAcceptance |
The task has been rejected to be rejected |
Outcome |
AwaitingApproval |
The task has been set to completed by the user specified |
Rejection |
Rejected |
The task has been rejected by the user specified |
Examples
addJournal(2188468, 1, "Comment", "test addJournal");
Availability
Version 4.8