REST Objects FlexView

ServiceMobility

When ServiceMobility is the primary sub-system for a Work Item object, then the structure of any associated FlexView objects in ServiceBroker is not defined at the ServiceBroker level. 

Instead, the FlexView object will be a pass-through object in ServiceBroker - that is, the FlexView object will have the object structure as defined by the version of ServiceMobility which is the primary sub-system.

Accordingly, please see the appropriate documentation for the FlexView object in the relevant version of ServiceMobility:

• ServiceMobility 3 - FlexView Object

ServiceScheduling

When ServiceScheduling is the primary sub-system for a Work Item object, then the structure of any associated FlexView objects in ServiceBroker is as defined below.

When ServiceScheduling is the primary sub-system for a Work Item object, and the above requirements are met (i.e. the moreNotes field of the Work Item in ServiceScheduling in XML, and the UseMoreNotesForJobInfo configuration setting is false), then there are two different ways that ServiceBroker will parse the moreNotes XML into FlexView objects, depending on the XML content provided by ServiceScheduling:

Basic More Notes Format

When the ServiceScheduling moreNotes XML is a simple list of one or more name/value pairs, representing simple additional notes in XML format, then ServiceBroker will parse this into a single FlexView object, with a Title value of "More Notes", and the name/value pairs being translated into corresponding Label/Value entries in the Items array.

For example, a moreNotes XML value in ServiceScheduling of:

<?xml version='1.0' encoding='UTF-8' ?>
	<notes>
		<p id='Email' x='3'>example@example.com</p>
		<p id='Mobile' x='3'>123456789</p>
		<p id='Home' x='3'>987654321</p>
	</notes>
</xml>

will be translated into a FlexView object of format:

{
	"Title": "More Notes",
    "Items": [
    	{
        	"Label": "Email",
            "Value": "example@example.com"
        },
        {
            "Label": "Mobile",
            "Value": "123456789"
        },
        {
            "Label": "Home",
            "Value": "987654321"
        }
    ]
}

Extended More Notes Format

In addition to supporting a simple list of name/value pairs in XML format, ServiceScheduling also supports a specific "extended" XML format, which allows specific Work Item asset, job description and customer details to be stored.

When the ServiceScheduling moreNotes XML is in this extended format, then ServiceBroker will parse this into a number of FlexView objects, with Title values based on the specific ServiceScheduling sections, with appropriate corresponding Label/Value entries in the Items array for each.

For example, a moreNotes XML value in ServiceScheduling of:

<?xml version='1.0' encoding='UTF-8' ?>
	<notes>
		<p id='ASSET' x='3'>----------------</p>
		<p id='Make' x='3'>ABC</p>
		<p id='Model' x='3'>AAA1234</p>
		<p id='Serial' x='3'>AABBCC1234567890</p>
		<p id='JOB_DESCRIPTION' x='3'>----------------</p>
		<p id='Description' x='3'>Problem with device.</p>
		<p id='CUSTOMER' x='3'>----------------</p>
		<p id='Email' x='3'>example@example.com</p>
		<p id='Mobile' x='3'>123456789</p>
		<p id='Home' x='3'>987654321</p>
	</notes>
</xml>

will be translated into three FlexView objects of format:

{
    "Title": "ASSET",
    "Items": [
        {
            "Label": "Make",
            "Value": "ABC"
        },
        {
            "Label": "Model",
            "Value": "AAA1234"
        },
        {
            "Label": "Serial",
            "Value": "AABBCC1234567890"
        }
    ]
},

{
    "Title": "JOB_DESCRIPTION",
    "Items": [
        {
            "Label": "Description",
            "Value": "Problem with device."
        }
    ]
},

{
    "Title": "CUSTOMER",
    "Items": [
        {
            "Label": "Email",
            "Value": "example@example.com"
        },
        {
            "Label": "Mobile",
            "Value": "123456789"
        },
        {
            "Label": "Home",
            "Value": "987654321"
        }
    ]
}

FlexView Object Format

{
	"Title": "",
	"Items": [
		{
			"Label": "",
			"Value": "",
		},
		{
			"Label": "",
			"Value": "",
		},
		...
	]
}

FlexView Object Properties