Namespace: AssessForm

Methods

Appearition.Job.AssessForm.ApproveFormReview (request, requestOptions) static

Updates the changes to fields and any reviewer comments and approves the submitted form. Will not return anything unless an error occurs

Name	Type	Description
request	Appearition.Job.AssessForm.JobAssignmentFormReviewViewModel	Contains all the fields along with any changes and reviewer comments
requestOptions	Appearition.RequestOptions	Contains the various callback methods for this request

Appearition.Job.AssessForm.FormIndex (jobAssignmentId, jobAssignmentFormId, requestOptions)Appearition.Job.AssessForm.JobAssignmentFormReviewViewModel static

This method will return all the data for a submitted form including audit information, field data and reviewers comments

Name	Type	Description
jobAssignmentId	number	The unique identifier of the job assignment
jobAssignmentFormId	number	The unique identifier of the submitted form on the job assignment
requestOptions	Appearition.RequestOptions	configure callbacks

Returns:

Type	Description
Appearition.Job.AssessForm.JobAssignmentFormReviewViewModel	This is returned as part of the success callback function in the requestOptions param

Appearition.Job.AssessForm.GetJobFormFile (jobAssignmentFormFileId, requestOptions)object static

Retrieves the contents of a specific submitted file

Name	Type	Description
jobAssignmentFormFileId	number	The unique identifier of the file on the field on the submitted form on the job assignment
requestOptions	Appearition.RequestOptions	Contains the various callback methods for this request

Returns:

Type	Description
object	File stream

Appearition.Job.AssessForm.RejectFormReview (request, requestOptions) static

Updates the changes to fields and any reviewer comments and rejects the submitted form. Will not return anything unless an error occurs

Name	Type	Description
request	Appearition.Job.AssessForm.JobAssignmentFormReviewViewModel	Contains all the fields along with any changes and reviewer comments
requestOptions	Appearition.RequestOptions	Contains the various callback methods for this request

Appearition.Job.AssessForm.UpdateFormReview (request, requestOptions) static

Updates the changes to fields and any reviewer comments on the submitted form. Will not return anything unless an error occurs

Name	Type	Description
request	Appearition.Job.AssessForm.JobAssignmentFormReviewViewModel	Contains all the fields along with any changes and reviewer comments
requestOptions	Appearition.RequestOptions	Contains the various callback methods for this request

Type Definitions

Appearition.Job.AssessForm.FormStatusEnum

The various status values for a submitted form in a job assignment.

Properties:

Name	Type	Description
ReadyForReview	number	801
ReviewInProgress	number	802
Approved	number	803
Rejected	number	804
UnSubmitted	number	805

Appearition.Job.AssessForm.JobActivityViewModel

This is the data structure returned by to send as part of the Appearition.Job.AssessForm.ListForms method

Properties:

Name	Type	Description
Activity	string	The action that has been performed on the job
FirstName	string	The first name of the user who performed the activity
LastName	string	The last name of the user who performed the activity
CreatedUtcDateDateDisplay	string	The date / time when the activity took place. The date is stored as UTC in the database but it is converted to the clients local timezone. Format "dd MMM yyyy h:mm tt"

Appearition.Job.AssessForm.JobAssignmentFormFieldViewModel

A data structure that represents the details of a specific field on a submitted form on a job assignment

Properties:

Name	Type	Description
JobAssignmentFormFieldId	number	The unique identifier of the field on the job assignment form record. This is a system generated value
JobAssignmentFormId	number	The unique identifier of the submitted form. This is a system generated value
FormFieldId	number	The unique identifier of the original field on the original form. This is a system generated value
FormFieldValue	string	The value of the field
FormFieldValueOriginal	string	The original value as entered by the form submitter. Used to handle rollback actions when editing
Barcode	string	If the field represents an asset, this holds the barcode that identifies the asset (i.e. part instance)
BarcodeOriginal	string	The original value as entered by the form submitter. Used to handle rollback actions when editing
SerialNo	string	If the field represents an asset, this holds the serial no of the asset (i.e. part instance)
SerialNoOriginal	string	The original value as entered by the form submitter. Used to handle rollback actions when editing
AssetAction	Appearition.Job.AssetActionEnum	If the field represents an asset, this holds the type of action being performed on the asset (i.e. part instance)
AssetActionOriginal	Appearition.Job.AssetActionEnum	The original value as entered by the form submitter. Used to handle rollback actions when editing
PartId	number	If the field represents an asset, this holds the identifier of the part that the asset is.
PartIdOriginal	number	The original value as entered by the form submitter. Used to handle rollback actions when editing
PushChangeIntoDb	boolean	This applies to asset fields. Indicates to the server that the changes to the asset should or should not be saved to the asset database. The system will run validation rules over asset fields after form submission. If something is wrong, the system will automatically set this value to false. The reviewer is able to override this decision.
PushChangeIntoDbOriginal	boolean	The original value as decided by the system. Used to handle rollback actions when editing
PartName	string	If the field represents an asset, this holds the name of the part that the asset is.
PartNameOriginal	string	The original value as entered by the form submitter. Used to handle rollback actions when editing
ModelId	number	If the field represents an asset, this holds the unique identifier to the model of the asset
ModelNo	string	If the field represents an asset, this holds the identifier to the model of the asset
ModelNoOriginal	string	The original value as entered by the form submitter. Used to handle rollback actions when editing
NewModelNo	string	If the field represents an asset and the action is to add a new asset into the system, this holds the identifier to a model that does not yet exist in the asset database
NewModelNoOriginal	string	The original value as entered by the form submitter. Used to handle rollback actions when editing
ManufacturerId	number	If the field represents an asset, this holds the unique identifier to the manufacturer of the asset
ManufacturerName	string	If the field represents an asset, this holds the name of the manufacturer of the asset
ManufacturerNameOriginal	string	The original value as entered by the form submitter. Used to handle rollback actions when editing
NewManufacturerName	string	If the field represents an asset and the action is to add a new asset into the system, this holds the name of a manufacturer that does not yet exist in the asset database
NewManufacturerNameOriginal	string	The original value as entered by the form submitter. Used to handle rollback actions when editing
SupplierId	number	If the field represents an asset, this holds the unique identifier to the supplier of the asset
SupplierIdOriginal	string	The original value as entered by the form submitter. Used to handle rollback actions when editing
SupplierName	string	If the field represents an asset, this holds the name of the supplier of the asset
SupplierNameOriginal	string	The original value as entered by the form submitter. Used to handle rollback actions when editing
NewSupplierName	string	If the field represents an asset and the action is to add a new asset into the system, this holds the name of a supplier that does not yet exist in the asset database
NewSupplierNameOriginal	string	The original value as entered by the form submitter. Used to handle rollback actions when editing
Comment	string	Holds a comment about tje field.
JobAssignmentFormFieldForAsset_ParentId	number	If the field represents an asset, and the field is a sub part, then this property represents the parent part instance
PartInstanceId	number	If the field represents an asset, this property is the unique identifier to the asset record in the asset database (i.e. part instance)
CanEditSubPart	boolean	If the field represents an asset and sub part, this property indicates if the sub part can be changed by the reviewer
SubPartAction	Appearition.Job.AssetActionEnum	If the field represents an asset and sub part, this property holds the numeric value of the asset action being requested on the sub part
SubPartCurrentParentId	number	This is applicable if the field represents an asset and sub part. Once of the asset actions is to move a sub part to another parent. This fields holds the value of the current parent as found in the asset database
SubPartCurrentParentPartName	string	This is applicable if the field represents an asset and sub part. It holds the name of the part of the parent
SubPartCurrentParentBarcode	string	This is applicable if the field represents an asset and sub part. It holds the barcode of the part of the parent
PurchaseDate	string	This is applicable if the field represents an asset. It holds the date when the part was purchased from the supplier
PurchaseDateOriginal	string	The original value as entered by the form submitter. Used to handle rollback actions when editing
WarrantyExpiryDate	string	This is applicable if the field represents an asset. It holds the date when the part will expire
WarrantyExpiryDateOriginal	string	The original value as entered by the form submitter. Used to handle rollback actions when editing
InEditValueMode	bool	Used for UI. Can be used to control data entry behaviour
FieldType	number	This defines what kind of field is presented on the form. There are many values
FieldTypeName	string	the name of field type
FieldHasValue	bool	Indicates if the field type allows data entry on the form. Some field types only provide structure or read only capabilities on the form.
FieldHasFiles	bool	Indicates if the field type is associated with files. Some field types present or capture files on the form (e.g. Take Photo allows a user to attach a photo from their device).
FieldLabel	string	The text presented to the form submitter as a prompt for entering a value or performing an action
Instructions	string	The detailed text presented to the form submitter as a guide for entering a value or performing an action
Ordinal	number	The position of the field on the form relative to other fields. Zero based index
ReviewerComments	string	Text entered by reviewers
SubFormId	number	If this field belongs to a sub form, this field unique identifies that sub form. Deprecated
SubForms	Array.<Appearition.Job.AssessForm.JobAssignmentFormReviewViewModel>	If this field links to sub forms, this collection contains the sub forms. Deprecated
Exceptions	Array.<string>	If the field represents an asset, this collection holds all errors the system has found as part of the asset validation rules process.

Appearition.Job.AssessForm.JobAssignmentFormFileViewModel

A data structure that represents a file linked to a specific field on a submitted form on a job assignment

Properties:

Name	Type	Description
JobAssignmentFormFileId	number	The unique identifier of the file that is linked to the field on the job assignment form record. This is a system generated value
FileName	string	The name of the linked file
ReviewerComments	string	Text entered by reviewers

Appearition.Job.AssessForm.JobAssignmentFormReviewViewModel

A data structure that represents the details of a job assignment

Properties:

Name	Type	Description
JobAssignment	Appearition.Job.JobAssignmentForReviewViewModel	The details of the job assignment this form is linked to.
JobForm	Appearition.Job.Assess.JobAssignmentFormViewModel	The details of the submitted form for the job assignment.
CanEditFormValues	boolean	Indicates if the reviewer is allowed to change the submitted field values.
CanReview	boolean	Indicates if the form is in a state that can be reviewed.
ReviewerComments	string	Text entered by reviewers.
Fields	Array.<Appearition.Job.AssessForm.JobAssignmentFormFieldViewModel>	The collection of all fields on the form with the values entered and any reviewer comments.
FieldSubpart	Array.<Appearition.Job.AssessForm.JobAssignmentFormFieldViewModel>	If the field represents an action to an asset, this holds a collection of sub part instances affected.
Files	Array.<Appearition.Job.AssessForm.JobAssignmentFormFileViewModel>	All files submitted as part of the form are available in this collection.
PartManufacturers	Array.<Appearition.Job.AssessForm.PartManufacturerViewModel>	A collection of manufacturers for parts. Can be used on the UI if the field is an asset action and field values can be edited by the reviewer.
ManufacturerModels	Array.<Appearition.Job.AssessForm.ManufacturerModelViewModel>	A collection of models that manufacturers have for parts. Can be used on the UI if the field is an asset action and field values can be edited by the reviewer.
Suppliers	Array.<Appearition.Job.AssessForm.SupplierViewModel>	A collection of supplier for parts. Can be used on the UI if the field is an asset action and field values can be edited by the reviewer.
Parts	Array.<Appearition.Job.AssessForm.PartListViewModel>	A collection of parts. Can be used on the UI if the field is an asset action and field values can be edited by the reviewer.
AssetActions	Array.<Appearition.SelectListItem>	Refer to Appearition.Job.AssetActionEnum. A collection of actions that can be taken on an asset. Can be used on the UI if the field is an asset action and field values can be edited by the reviewer.
IsSelected	boolean	Indicates if the form has been selected. This is mainly used in a UI and relates to a collection of forms in a list.
IsReadOnly	boolean	Indicates if the form can be modified or read only.
PdfTemplates	Array.<Appearition.SelectListItem>	A collection of templates that can be used to generate a custom formatted report for the submitted form.

Appearition.Job.AssessForm.JobAssignmentFormViewModel

Data model holds the details of a submitted form on a submitted job assignment

Properties:

Name	Type	Description
JobAssignmentFormId	number	The unique identifier of the job assignment form record. This is a system generated value
JobAssignmentId	number	The unique identifier of the job assignment record. This is a system generated value
FormId	number	The unique identifier of the original form that the submitted form is based on. This is a system generated value
EnteredUtcDateDisplay	string	The date/time when the form was entered by the user (format dd MMM yyyy h:mm tt). Note, whilst the field name has UTC in it, the server side is actually converting the date time to Melbourne, Australia time (AEST)
CreatedUtcDateDateDisplay	string	The date/time when the job assignment form record was created on the server. This value can differ from the EnteredUtcDateDisplay if the user was working on an offline client and submitted the form at a later date/time.Format dd MMM yyyy h:mm tt. Note, whilst the field name has UTC in it, the server side is actually converting the date time to Melbourne, Australia time (AEST).
FormStatus	Appearition.Job.AssessForm.FormStatusEnum	The numeric version of the status of the submitted form, refer to the FormStatusEnum for options
FormStatusName	string	The name of the status of the submitted form, refer to the FormStatusEnum for options
FormName	string	The original name of the form
DefaultPdfTemplateName	string	The selected template that will be used to generate a report for the submitted form
CanReview	boolean	Indicates if the submitted form is in a state that can be reviewed
HasAssets	boolean	Indicates if the submitted form has fields which impact the Assets in the system

Appearition.Job.AssessForm.JobReviewIndexViewModel

This is the data structure returned by to send as part of the Appearition.Job.AssessForm.ListForms method

Properties:

Name	Type	Description
JobAssignment	Appearition.Job.JobAssignmentForReviewViewModel	The job assignment details
JobReview	Appearition.Job.JobReviewViewModel	The data model that holds the review details for the job
CanReview	boolen	Indicates if the job assignment is in a state which can be reviewed
Forms	Array.<Appearition.Job.AssessForm.JobAssignmentFormViewModel>	The collection of all of the submitted forms on this job assignment
Activity	Array.<Appearition.Job.AssessForm.JobActivityViewModel>	All audit activity recorded against this job assignment
IsReadOnly	boolean	Identifies job assignment review can be modified or read only
PdfTemplates	Array.<Appearition.SelectListItem>	A collection of templates that can be used to generate a custom formatted report for the submitted job assignment

Appearition.Job.AssessForm.ManufacturerModelViewModel

A data structure that represents the model of the part that the specific manufacturer has

Properties:

Name	Type	Description
Id	number	The unique identifier to the Part/Manufacturer/Model record. This is a system generated value
PartId	number	The unique identifier of the part. This is a system generated value
ManufacturerId	number	The unique identifier of the manufacturer. This is a system generated value
ModelNo	string	The descriptive text for the model

Appearition.Job.AssessForm.PartListViewModel

A data structure that represents a part in the asset database

Properties:

Name	Type	Description
PartId	number	The unique identifier of the part. This is a system generated value
PartName	string	The name of the part

Appearition.Job.AssessForm.PartManufacturerViewModel

A data structure that represents the manufacturer of a specific part along with all of the models of the part that the manufacturer has

Properties:

Name	Type	Description
Id	number	The unique identifier to the Part/Manufacturer record. This is a system generated value
PartId	number	The unique identifier of the part. This is a system generated value
ManufacturerId	number	The unique identifier of the manufacturer. This is a system generated value
ManufacturerName	string	The name of the manufacturer
Models	Array.<Appearition.Job.AssessForm.ManufacturerModelViewModel>	The collection of models that this manufacturer has for this part

Appearition.Job.AssessForm.SupplierViewModel

A data structure that represents a supplier in the asset database

Properties:

Name	Type	Description
Id	number	The unique identifier to the Part/Manufacturer/Model record. This is a system generated value
Name	string	The name of the supplier