Difference between revisions of "Task new"

From Catglobe Wiki
Jump to: navigation, search
(Tag: visualeditor)
 
(5 intermediate revisions by the same user not shown)
Line 7: Line 7:
 
'''Syntax'''  
 
'''Syntax'''  
  
−
Task_new(taskname, parentResourceId[, taskTemplateResourceId][, taskDescription])  
+
Task_new(taskname, parentResourceId[, taskDescription][, taskTemplateResourceId])  
  
 
'''Arguments'''  
 
'''Arguments'''  
Line 13: Line 13:
 
*taskname: is string. It is the name of new task  
 
*taskname: is string. It is the name of new task  
 
*parentResourceId: is number. It is parent resource id of the new task  
 
*parentResourceId: is number. It is parent resource id of the new task  
 +
*taskDescription: is string. It is journal's description of task
 
*taskTemplateResourceId: is number. It is the template resource Id  
 
*taskTemplateResourceId: is number. It is the template resource Id  
−
*taskDescription: is string. It is journal's description of task
+
 
  
 
'''Return value'''  
 
'''Return value'''  
Line 168: Line 169:
 
array DateTime
 
array DateTime
  
−
| style="border: 1px solid #010101" width="356" |
+
| style="border: 1px solid #010101" width="356" |{1,1,1,1,0,0,0,1,40}
 
   
 
   
 
|- valign="top" align="left"
 
|- valign="top" align="left"
Line 177: Line 178:
 
array DateTime
 
array DateTime
  
−
| style="border: 1px solid #010101" width="356" |  
+
| style="border: 1px solid #010101" width="356" | {9999,12,31,23,59,59,999,52,40}
 
   
 
   
 
|- valign="top" align="left"
 
|- valign="top" align="left"
Line 186: Line 187:
 
array DateTime
 
array DateTime
  
−
| style="border: 1px solid #010101" width="356" |  
+
| style="border: 1px solid #010101" width="356" | {1,1,1,1,0,0,0,1,40}
 
   
 
   
 
|- valign="top" align="left"
 
|- valign="top" align="left"
Line 195: Line 196:
 
array DateTime (read only)
 
array DateTime (read only)
  
−
| style="border: 1px solid #010101" width="356" |  
+
| style="border: 1px solid #010101" width="356" | {1,1,1,1,0,0,0,1,40}
 
   
 
   
 
|- valign="top" align="left"
 
|- valign="top" align="left"
Line 204: Line 205:
 
array DateTime (read only)
 
array DateTime (read only)
  
−
| style="border: 1px solid #010101" width="356" |  
+
| style="border: 1px solid #010101" width="356" | {9999,12,31,23,59,59,999,52,40}
 
   
 
   
 
|- valign="top" align="left"
 
|- valign="top" align="left"
Line 213: Line 214:
 
array DateTime (read only)
 
array DateTime (read only)
  
−
| style="border: 1px solid #010101" width="356" |
+
| style="border: 1px solid #010101" width="356" |{1,1,1,1,0,0,0,1,40}
 
   
 
   
 
|- valign="top" align="left"
 
|- valign="top" align="left"
Line 221: Line 222:
 
| style="border: 1px solid #010101" width="356" | number
 
| style="border: 1px solid #010101" width="356" | number
  
−
| style="border: 1px solid #010101" width="356" |
+
| style="border: 1px solid #010101" width="356" |0
  
 
|- valign="top" align="left"
 
|- valign="top" align="left"
Line 229: Line 230:
 
| style="border: 1px solid #010101" width="356" | string
 
| style="border: 1px solid #010101" width="356" | string
  
−
| style="border: 1px solid #010101" width="356" |
+
| style="border: 1px solid #010101" width="356" |Entered value (Task name is default if not specified)
  
 
|- valign="top" align="left"
 
|- valign="top" align="left"
Line 236: Line 237:
 
| style="border: 1px solid #010101" width="356" | number (read only)
 
| style="border: 1px solid #010101" width="356" | number (read only)
  
−
| style="border: 1px solid #010101" width="356" |
+
| style="border: 1px solid #010101" width="356" |0
  
 
|- valign="top" align="left"
 
|- valign="top" align="left"
Line 291: Line 292:
 
TASK_OBSERVER:  
 
TASK_OBSERVER:  
  
−
{{current user's resource id, "FullControl"}}  
+
List of user or group which is observer of this task { {observer's resource id, control access, observer's name},...}
  
−
List of user or group which is observer of this task { {observer's resource id, control access},...}  
+
Ex: <nowiki>{{123,RESOURCE_ACCESS_OBSERVER, John Smith (JohnSmith)},{246,RESOURCE_ACCESS_MANAGER, Alice Sophia Eve (AliceAve)}}</nowiki>
  
−
Ex: <nowiki>{{1,"RESOURCE_ACCESS_OBSERVER"},{2,"RESOURCE_ACCESS_MANAGER"}}</nowiki>  
+
Or:<nowiki>{{123,2, John Smith (JohnSmith)},{246,4, Alice Sophia Eve (AliceAve)}}</nowiki>  
  
 
In which, control access constants are:  
 
In which, control access constants are:  
  
−
*RESOURCE_ACCESS_OBSERVER  
+
{| class="tableintopic" style="border-collapse:collapse; border:1px solid #010101" width="444" cellspacing="0" cellpadding="2" border="1"
−
*RESOURCE_ACCESS_MANAGER  
+
|- valign="top" align="left"
−
*RESOURCE_ACCESS_ADMINISTRATOR
+
| style="border:1px solid #010101;" width="120" bgcolor="#C0C0C0" |
 +
'''Index'''
 +
 
 +
| style="border:1px solid #010101;" width="324" bgcolor="#C0C0C0" |
 +
'''Constant name'''
 +
 
 +
|- valign="top" align="left"
 +
| style="border:1px solid #010101;" width="120" |
 +
2
 +
 
 +
| style="border:1px solid #010101;" width="324" |
 +
RESOURCE_ACCESS_OBSERVER
 +
 
 +
|- valign="top" align="left"
 +
| style="border:1px solid #010101;" width="120" |
 +
4
 +
 
 +
| style="border:1px solid #010101;" width="324" |
 +
RESOURCE_ACCESS_MANAGER
 +
 
 +
|- valign="top" align="left"
 +
| style="border:1px solid #010101;" width="120" |
 +
6
 +
 
 +
| style="border:1px solid #010101;" width="324" |
 +
RESOURCE_ACCESS_ADMINISTRATOR
 +
 
 +
|}
 +
 
 +
Observer's name can be set by function [[User_formatName]]
  
 
'''''Explanation **'''''  
 
'''''Explanation **'''''  
Line 348: Line 378:
  
 
|}
 
|}
 +
 +
'''Example'''
 +
 +
<source lang="javascript">
 +
string taskname = "Test Task";
 +
number responsibleRId = 14042920;
 +
number supervisorRId = 12344998;
 +
number observerRId = 10768810;
 +
number parentResourceId = 11088827;
 +
number taskTemplateResourceId = 2072;
 +
array task = Task_new(taskname, parentResourceId, taskTemplateResourceId);
 +
task[TASK_RESPONSIBLE_RESOURCE_ID] = responsibleRId;
 +
task[TASK_SUPERVISOR_RESOURCE_ID ] = supervisorRId;
 +
task[TASK_OBSERVER]={{observerRId, 2, User_formatName(User_getUserByResourceId(observerRId))}};
 +
task[TASK_ACCEPTANCE_DEADLINE]=DateTime_getByYMD(2017,10,18);
 +
task[TASK_COMPLETION_DEADLINE]=DateTime_getByYMD(2017,10,21);
 +
task[TASK_APPROVAL_DEADLINE]=DateTime_getByYMD(2017,10,30);
 +
task[TASK_DESCRIPTION]="This task with high priority";
 +
Task_save(task);
 +
</source>
  
 
'''Availability'''  
 
'''Availability'''  

Latest revision as of 08:30, 17 October 2017



Contents

Task_new

Create new task object

Syntax

Task_new(taskname, parentResourceId[, taskDescription][, taskTemplateResourceId])

Arguments

  • taskname: is string. It is the name of new task
  • parentResourceId: is number. It is parent resource id of the new task
  • taskDescription: is string. It is journal's description of task
  • taskTemplateResourceId: is number. It is the template resource Id


Return value

Array which is Task object:

Index

Data type

Initial Value

TASK_RESOURCE_ID

number

0

TASK_CASE_NUMBER

number

0

TASK_NAME

string

Entered value

TASK_PARENT_RESOURCE_ID

number

Entered value

TASK_TEMPLATE_RESOURCE_ID

number

Entered value (default if it is not specified)

TASK_TIME_REGISTRATION

bool

TRUE

TASK_COMPLETED

bool (read only)

FALSE

TASK_TESTCASE_RESOURCE_ID

number

0 (Always = 0 if test case is not required)

TASK_RESPONSIBLE_RESOURCE_ID

number

0

TASK_SUPERVISOR_RESOURCE_ID

number

0

TASK_OBSERVER

array

(Explanation *)

TASK_OBSERVER_INHERIT_ACCESS

bool

FALSE

TASK_STATUS

number (read only)

(Explanation **) 

TASK_ACCEPTANCE_DEADLINE

array DateTime

{1,1,1,1,0,0,0,1,40}

TASK_COMPLETION_DEADLINE

array DateTime

{9999,12,31,23,59,59,999,52,40}

TASK_APPROVAL_DEADLINE

array DateTime

{1,1,1,1,0,0,0,1,40}

TASK_ACTUAL_START_DATE

array DateTime (read only)

{1,1,1,1,0,0,0,1,40}

TASK_ACTUAL_END_DATE

array DateTime (read only)

{9999,12,31,23,59,59,999,52,40}

TASK_APPROVED_DATE

array DateTime (read only)

{1,1,1,1,0,0,0,1,40}

TASK_MAN_HOURS

number 0

TASK_DESCRIPTION

string Entered value (Task name is default if not specified)
TASK_VERSION number (read only) 0

TASK_CREATED_DATE

array DateTime (read only)

TASK_MODIFIED_DATE

array DateTime (read only)

TASK_RESPONSIBLE_NAME

string (read only)

TASK_SUPERVISOR_NAME

string (read only)

TASK_CURRENT_USER_IS_RESPONSIBLE

bool (read only)

TASK_CURRENT_USER_IS_SUPERVISOR

bool (read only)

Explanation *

TASK_OBSERVER:

List of user or group which is observer of this task { {observer's resource id, control access, observer's name},...}

Ex: {{123,RESOURCE_ACCESS_OBSERVER, John Smith (JohnSmith)},{246,RESOURCE_ACCESS_MANAGER, Alice Sophia Eve (AliceAve)}}

Or:{{123,2, John Smith (JohnSmith)},{246,4, Alice Sophia Eve (AliceAve)}}

In which, control access constants are:

Index

Constant name

2

RESOURCE_ACCESS_OBSERVER

4

RESOURCE_ACCESS_MANAGER

6

RESOURCE_ACCESS_ADMINISTRATOR

Observer's name can be set by function User_formatName

Explanation **

TASK_STATUS:

Default value is 0

Constants:

Index

Constant name

0

TASK_STATUS_NEEDACCEPTANCE

1

TASK_STATUS_INPROGRESS

2

TASK_STATUS_APPROVED

3

TASK_STATUS_AWAITINGAPPROVAL

Example 

string taskname = "Test Task";
number responsibleRId = 14042920;
number supervisorRId = 12344998;
number observerRId = 10768810;
number parentResourceId = 11088827;
number taskTemplateResourceId = 2072;
array task = Task_new(taskname, parentResourceId, taskTemplateResourceId);
task[TASK_RESPONSIBLE_RESOURCE_ID] = responsibleRId;
task[TASK_SUPERVISOR_RESOURCE_ID ] = supervisorRId;
task[TASK_OBSERVER]={{observerRId, 2, User_formatName(User_getUserByResourceId(observerRId))}};
task[TASK_ACCEPTANCE_DEADLINE]=DateTime_getByYMD(2017,10,18);
task[TASK_COMPLETION_DEADLINE]=DateTime_getByYMD(2017,10,21);
task[TASK_APPROVAL_DEADLINE]=DateTime_getByYMD(2017,10,30);
task[TASK_DESCRIPTION]="This task with high priority";
Task_save(task);

Availability

Version 5.8

Retrieved from "http://wiki.catglobe.com/index.php?title=Task_new&oldid=235813"