This
call can be used to create an ActionItem. User can specify the coordinator,
routes, stages etc while creating ActionItem.
|
Name |
Parent Tag |
Description |
Valid Values |
Default Values |
Option |
Root |
Unique option for the call |
NGOCreate ActionItem |
N/A |
CabinetName |
Root |
Name of the Database cabinet to which user wants to connect. |
The name of the cabinet. |
N/A |
UserDBId |
Root |
UserDatabse ID, which is returned in the NGOConnect Cabinet call |
|
N/A |
CurrentDate Time |
Root |
Current Date and Time when ActionItem was defined |
A valid date in the format yyyy-mm-dd hh:mm:ss |
Current Date and time |
Coordinator Index |
Root |
Index of the user who will act as a coordinator of ActionItem. |
Index>= 0 |
|
Coordinator Name |
Root |
Name of the user who will act as a coordinator of ActionItem. |
|
|
MainFolderIndex |
Root |
Reserved. User can pass the value as 0. |
|
|
MainGroupIndex |
Root |
Reserved. User can pass the value as 0. |
|
|
AdminGroup Index |
Root |
Index of
the Group formed by the Root Members of the Action Item. |
Integer
> 0 |
N/A |
MainGroup Name |
Root |
Reserved. User should not pass any value for it |
|
|
ActionItemName |
Root |
Name of the ActionItem |
|
|
ImageVolume Index |
Root |
Image and volume index of the folder which will be created during
ActionItem creation |
|
|
Members |
Root |
It contains list of those members for whom reminders has been defined.
These members will be added to the group that will be created by this call. |
|
|
Member |
Members |
Index of the user for whom reminder has been defined. |
Integer > = 0 |
|
DataDefinition |
Root |
It contains information about the details of the data class created at
the time of ActionItem creation whose fields contains the properties of
ActionItem like stages, route etc. It contains 21 fields that are described
in above section |
|
|
Fields |
DataDefinition |
It contains information about the fields of data class, which contains
definition of ActionItem. |
|
|
Field |
Fields |
It contains information about individual field of the data class |
|
|
IndexName |
Field |
Name of the field |
|
|
IndexType |
Field |
Index type of the field |
|
|
IndexLength |
Field |
Length of the field |
|
|
Acknowledge Value |
Root |
Flag, which indicates whether to acknowledge initiator whenever the
ActionItem is completed by some user in the route |
Y-Acknowledgment has to be made to initiator N- No Acknowledgment has to be made to initiator |
|
AlarmsValue |
Root |
It contains the alarms and reminder that are defined for ActionItem |
|
|
CurrentStage Value |
Root |
|
|
|
ActionItemData |
Root |
|
|
|
UserGroupACLs |
Root |
It contains information about users and groups to whom rights have to
be assigned on ActionItem folder. |
|
|
UserGroupACL |
UserGroup ACLs |
It contains information about Individual user or group to whom rights
have to be assigned on ActionItem folder. |
|
|
UserGroupIndex |
UserGroup ACL |
User Index or group Index of the user to whom assign rights |
Integer > = 0 |
|
UserGroupType |
UserGroup ACL |
Whether the specified member is User or Group |
U- User G- Group |
|
Rights |
UserGroup ACL |
Rights that will be assigned to user or group specified |
|
|
Name |
Parent Tag |
Description |
Option |
Root |
NGOCreateActionItem |
Status |
Root |
Status of the call. If Status is 0 then the call is successful. |
Code |
Message |
Comments |
-50074 |
Invalid parameters |
|
-50014 |
Group name already exist. |
Group with the same name already exists that is created during
ActionItem definition |
-50017 |
Folder not found. |
Folder specified in input does not exist in the system |
-50120 |
Folder with the same name already exists. |
Folders that are created during ActionItem definition already exist.
This can occur when ActionItem with the same name already exists |