XML Integration Example: XML messages sent during processing

    Scenario: XML messages sent in and out during typical work order processing.

    This scenario covers the following intercommunication:

    1. [SC → Prov] New WO created
    2. [Prov → SC] WO dispatch confirmed
    3. [SC → Prov] Check in via IVR
    4. [SC → Prov] Check out via IVR
    5. [Prov → SC] New note created
    6. [SC → Prov] Priority and NTE updated
    7. [Prov → SC] Check in via XML
    8. [Prov → SC] Check out via XML
    9. [SC → Prov] Completion confirmation

     

    1. [SC → Prov] New WO created

    New work order created by subscriber is sent to provider as the following XML message

    <?xml version="1.0" encoding="utf-16"?>

        <DATA2SC PIN="1069693" ID="67099954">

           <CALL

                  TYPE="WONEW"

                  DATETIME="2016/01/21 07:48:00"

                  OPERATOR="SoWerxXML1"

                  CALLER="test-xml"

                  CATEGORY="CAPITAL - OTHER"

                  SUB="2014917018"

                  LOC="SoWerx-XML"

                  TRADE="BUILDING EXTERIOR"

                  PRO="2000074085"

                  PRO_NAME="SoWerx Contractor Services"

                  TR_NUM="67099954"

                  WO_NUM="67099954"

                  PO_NUM="67099954"

                  STATUS="OPEN"

                  PRIORITY="Sev 3"

                  NTE="500"

                  SCHED_DATETIME="2016/01/28 07:48:00">

                 <PROBLEM>sample work order</PROBLEM>

           </CALL>

        </DATA2SC>

     

     

    1. [Prov → SC] WO dispatch confirmed

    Provider confirms dispatch:

    <?xml version="1.0"?>

        <DATA2SC PIN="1069693" ID="67099955">

        <CALL TR_NUM="67099954" STATUS="DISPATCH_CONFIRMED" />

    </DATA2SC>

     

    Updated WO status indicated in UI:

    Dispatch Confimed

    1. [SC → Prov] Check in via IVR or GPS app

    Now technician visited the location and reported check in via IVR. In this case outgoing XML notification is sent to provider:

    <?xml version="1.0" encoding="utf-16"?>

        <DATA2SC PIN="1069693" ID="63122971">

    <CALL TYPE="WOUPDATE" DATETIME="2016/01/21 07:48:00" OPERATOR="SoWerxXML1" CALLER="test-xml" CATEGORY="CAPITAL - OTHER" SUB="2014917018" LOC="SoWerx-XML" TRADE="BUILDING EXTERIOR" PRO="2000074085" PRO_NAME="SoWerx Contractor Services" TR_NUM="67099954" WO_NUM="67099954" PO_NUM="67099954"

    STATUS="ON_SITE"

    PRIORITY="Sev 3" NTE="500" SCHED_DATETIME="2016/01/28 07:48:00" COMPL_DATETIME="2016/01/21 08:24:18">

    <PROBLEM>sample work order</PROBLEM>    

    <CHECK

    TYPE="IN"

    PIN="1069693"

    DATETIME="2016/01/21 08:24:18"

    TECHS_COUNT="1"

    CALLERID="266696687" />  

                </CALL>

        </DATA2SC>

    WO details indicated in UI:

    IVR Usage

    1. [SC → Prov] Check out via IVR or GPS app

    Check out via IVR - work is not yet completed, some parts should be ordered.

    <?xml version="1.0" encoding="utf-16"?>

    <DATA2SC PIN="1069693" ID="63122971">

    <CALL TYPE="WOUPDATE" DATETIME="2016/01/21 07:48:00" OPERATOR="SoWerxXML1" CALLER="test-xml" CATEGORY="CAPITAL - OTHER" SUB="2014917018" LOC="SoWerx-XML" TRADE="BUILDING EXTERIOR" PRO="2000074085" PRO_NAME="SoWerx Contractor Services" TR_NUM="67099954" WO_NUM="67099954" PO_NUM="67099954"

    STATUS="PARTS_ON_ORDER"

    PRIORITY="Sev 3" NTE="500" SCHED_DATETIME="2016/01/28 07:48:00" COMPL_DATETIME="2016/01/21 09:24:18">

    <PROBLEM>sample work order</PROBLEM>    

    <CHECK

    TYPE="OUT"

    PIN="1069693"

    DATETIME="2016/01/21 09:24:18"

    TECHS_COUNT="1"

    CALLERID="266696687" />  

    </CALL>

    </DATA2SC>

    Parts on Order

    1. [Prov → SC] New note created

    Provider sent a note to subscriber asking to increase NTE value:

    <?xml version="1.0"?>

        <DATA2SC PIN="1069693" ID="67133896">

        <CALL TR_NUM="67099954">

            <ATTR NAME="NOTE">Please increase NTE on this call to $760 - additional parts should be ordered</ATTR>

        </CALL>

    </DATA2SC>

     

    1. [SC → Prov] Priority and NTE, Scheduled Date updated

    Subscriber changed multiple fields, including NTE as requested.

    <?xml version="1.0" encoding="utf-16"?>

    <DATA2SC PIN="1069693" ID="254284764">

    <CALL TYPE="WOUPDATE" DATETIME="2016/01/21 07:48:00"

    OPERATOR="test-xml" CALLER="test-xml"

    CATEGORY="CAPITAL - OTHER"

    SUB="2014917018" LOC="SoWerx-XML"

    TRADE="BUILDING EXTERIOR"

    PRO="2000074085"

    TR_NUM="67099954"

    WO_NUM="67099954"

    PO_NUM="67099954"

    STATUS="INCOMPLETE"

    PRIORITY="Sev 2"

    NTE="760"

    SCHED_DATETIME="2016/01/30 08:00:00">

    <PROBLEM>Test WO description updated</PROBLEM>

    <ATTR NAME="NOTE" LINE="5" DATETIME="2016/01/21 12:21:00"

    CREATED_BY="SoWerxXML1"

    NEW_SCHED_DATETIME="2016/01/30 08:00:00"

    SENT_TO="">

    WO Edited: status changed from IN PROGRESS/PARTS ON ORDER to IN PROGRESS/INCOMPLETE.

    WO Edited: Scheduled Date changed from Jan 29, 2016 08:00 to Jan 30, 2016 08:00.

    WO Edited: NTE changed from 500 to (USD)760.

    WO Edited: Priority changed from Sev 3 to Sev 2.

    </ATTR>

    </CALL>

    </DATA2SC>

     

    1. [Prov → SC] Check in via XML

    Technitian visited the location again, reporting check in via the following incoming XML message:
            <?xml version="1.0"?>

    <DATA2SC PIN="1069693" ID="146889">

    <CALL TR_NUM="67099954" STATUS="ON_SITE">

    <CHECK

    TYPE="IN"

    ID="2"

    DATETIME="2016/01/21 07:58:00">

    </CHECK>

    </CALL>

    </DATA2SC>

     

    1. [Prov → SC] Check out via XML

    Check out was also reported via XML. This time work is completed. Note COMPL_DATETIME should be specified in this case.


    <?xml version="1.0"?>

    <DATA2SC PIN="1069693" ID="146889">

    <CALL TR_NUM="67099954" STATUS="COMPLETED_PENDING"

    COMPL_DATETIME="2016/01/22 06:35:00">

    <CHECK TYPE="OUT"

    ID="2"

    DATETIME="2016/01/22 06:35:00">

    </CHECK>

    </CALL>

    </DATA2SC>

     

    1. [SC → Prov] Completion confirmation

    Subscriber confirms workorder completed. Now WO is in billable status. Autogenerated note about status change is sent to provider.


    <?xml version="1.0" encoding="utf-16"?>

    <DATA2SC PIN="1069693" ID="254243219">

    <CALL TYPE="WOUPDATE" DATETIME="2016/01/21 07:48:00"

    OPERATOR="test-xml" CALLER="test-xml"

    CATEGORY="CAPITAL - OTHER"

    SUB="2014917018" LOC="SoWerx-XML"

    TRADE="BUILDING EXTERIOR" PRO="2000074085"

    TR_NUM="67099954"

    WO_NUM="67099954"

    PO_NUM="67099954"

    STATUS="COMPLETED_CONFIRMED"

    PRIORITY="Sev 2" NTE="760"

    SCHED_DATETIME="2016/01/28 07:48:00"

    COMPL_DATETIME="2016/01/22 06:35:00">

    <PROBLEM>sample work order</PROBLEM>

    <ATTR NAME="NOTE" LINE="3"

    DATETIME="2016/01/22 07:02:00"

    CREATED_BY="SoWerxXML1"

    NEW_SCHED_DATETIME="2016/01/28 07:48:00"

    SENT_TO="">

    WO Edited: status changed from COMPLETED/PENDING CONFIRMATION to COMPLETED/CONFIRMED.

    </ATTR>

    </CALL>

    </DATA2SC>

    Confirmed