Error Types and Error Codes

This topic describes the error types and error codes related to the close message.

The error types related to the close message are:

Type	Occurs When	Available Message Fields
TYPE_ENTITY_ACTION	Requested action is inapplicable for the specified entity	entity entityId
TYPE_ENTITY_PROPERTY	Value of one of the properties, submitted by the plug-in to be updated, has an invalid value or violates a business rule for the given entity and conditions	entity entityId propertyLabel
TYPE_INTERNAL	Oracle Field Service is unable to process message due to: Invalid format or contents of message, or Unexpected internal error	NA

These error message fields are available:

• entity: Data for the listed entity is invalid ("activity" or "inventory")

• entityId: Id of the entity, for which the data is invalid (such as aid for activity and invid for inventory, for example, "10028719")

• propertyLabel: Label of the property, for which the value is invalid, for example, "customer_number", "WO_TYPE"

These error codes are available for the close message:

Code	Occurs When
TYPE_ENTITY_ACTION
CODE_ACTION_ON_PAST_DATE_NOT_ALLOWED	The requested action is forbidden for the entity, if it's assigned for an archived (past) queue: The plug-in tries to update the activity properties that are in the past and overnight or overtime limit is elapsed The plug-in tries to update the inventory properties in the customer, installed, or deinstalled pool of activity, which is in the past and overnight or overtime limit is elapsed
TYPE_ENTITY_PROPERTY
CODE_PROPERTY_VALUE_TOO_LARGE	Any of these: Property type is 'field' and length of its value exceeds 119 UTF-16 codepoints Property type is 'file', its GUI type is 'signature' and length of its value exceeds 102400 UTF-16 codepoints Property is neither field nor signature and length of its value exceeds 32767 UTF-16 codepoints See the Property Value Length and Limits section for details.
CODE_MANDATORY_PROPERTY_EMPTY	Any of these: For activity 'astatus' value is empty For inventory 'invpool' is 'install', 'deinstall' or 'customer' and 'inv_aid' value is empty 'invpool' is 'install', 'deinstall' or 'provider' and 'inv_pid' value is empty 'invpool' value is empty
CODE_ACTIVITY_STATUS_INVALID	Any of these: 'astatus' of the activity doesn't equal one of: 'pending', 'started', 'enroute', 'complete', 'suspended', 'notdone', 'cancelled' 'astatus' of the activity is 'enroute' and 'Enroute Support' option is disabled on the 'Business Rules' page. Transition from the current activity status to the new one, specified in 'astatus', is not allowed. See the Possible transitions between activity statuses graph for details.
CODE_INVENTORY_POOL_INVALID	Any of these: 'invpool' of inventory doesn't equal one of: 'customer', 'install', 'deinstall', 'provider' Transition from the current inventory pool to the new one, specified in 'invpool', is not allowed See the Possible transitions between inventory pools graph for details.
CODE_INVENTORY_AID_INVALID	Any of these: 'invpool' of inventory is 'provider' and 'inv_aid' value is not empty 'invpool' of inventory is 'customer' or 'deinstall' and submitted 'inv_aid' value doesn't equal current value of 'inv_aid' 'inv_aid' doesn't equal 'aid' of the started activity in the same queue and submitted 'inv_aid' value doesn't equal the current value of 'inv_aid'
CODE_INVENTORY_PID_INVALID	Any of these: 'invpool' of the inventory is 'customer' and 'inv_pid' value is not empty 'invpool' of the inventory is 'deinstall' and 'inv_pid' value doesn't equal the current value of 'inv_pid' and doesn't equal the 'pid' of the currently selected resource or the resource’s teammates 'invpool' of the inventory is 'provider', 'install', or 'deinstall' and submitted 'inv_pid' value doesn't equal the current value of 'inv_pid'
CODE_ACTIVITY_STATUS_INVALID_FOR_FUTURE	'astatus' is not 'pending' or 'cancelled' and activity is assigned for the day in future relative to the current date in the provider's time zone
CODE_ACTIVITY_STATUS_STARTED_ALREADY_IN_QUEUE	'astatus' is 'started' or 'enroute' and there is another started activity in the same queue
CODE_ACTIVITY_STATUS_ENROUTE_ALREADY_IN_QUEUE	'astatus' is 'started' or 'enroute' and there is another en route activity in the same queue
CODE_ACTIVITY_STATUS_INVALID_FOR_INACTIVE_QUEUE	'astatus' is not 'pending' or 'cancelled' and the activity is assigned for a queue that is not activated or is deactivated
CODE_ACTIVITY_STATUS_INVALID_FOR_NON_TRAVEL_ACTIVITY	'astatus' is 'enroute' and the activity doesn't support "calculate travel" feature (is a non-travel activity)
CODE_ACTIVITY_STATUS_REORDERING_IS_NOT_ALLOWED	'astatus' is 'enroute', activity is ordered and is not first in the route, and "Allow activity reorder inside the route" option is not selected for the user type of the current user
TYPE_INTERNAL
CODE_UNKNOWN	Oracle Field Service is unable to process the message due to: Invalid format or contents of message, or Unexpected internal error occurred
TYPE_MESSAGE_FORMAT
CODE_METHOD_NOT_SUPPORTED	Any of these: Wrong value in the method field Broken sequence of the method calls (for example, something is sent after the 'close' message, or before the 'update' method is processed)