Versions Compared

Version Old Version 6 New Version 7
Changes made by

Cameron Ahana

Cameron Ahana

Saved on

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.
Warning

Draft - In progress

ITS Admin Message Specs

*** VALUES FOR "role" ***
    staff
    studentEmployee
*** SUBAFFILIATION MESSAGES ***

Questions/Comments

add would be coming into a new position or reactivated

...

, switch from student to staff
delete would be leaving ITS  or leaving a position

...

modify would be changing the phone number/office locations/

...

section

  • need to provide the before data so folks know what's changing

can a ITS person have multiple affiliations?

look at UHIMS phones / list of "phone" (ask Dana where she updates the phone number - does she update ITSADMIN and WPMS)

publisher confirm, onAck means that it was published

ITS Admin Message Specs





affiliation(json data specs, not a message)

uhUuidnon-empty, single value

affIDnon-empty, single value; persPositionID

orgHierarchynon-empty list

  • code
  • description


rolenon-empty, single value

officeLocationoptional, single object

  • building
  • floor
  • cubicle


phonesAsEnteredoptional, single value

faxesAsEnteredoptional, single value


ElementValues
role
  • staff
  • student
code (under orgHierarchy)
  • CIO
  • CIO-1
  • ADM
  • AT
  • AT-1
  • AT-2
  • AT-3
  • AT-4
  • AT-5
  • AT-SS
  • CSOC
  • CYB
  • ES
  • ES-1
  • ES-2
  • ES-3
  • ES-4
  • ES-5
  • ES-6
  • TI
  • TI-SYS
  • TI-SYS-DBA
  • TI-SYS-MID
  • TI-SYS-SAA
  • TI-DCTR
  • TI-NETWK
  • TI-PROJ
  • TI-APC
  • TI-SEC
  • TI-TEL-US

Employee (Staff & Student)

Code Block
ROUTING KEY: affiliation.add.{role}.{orgRootCode}.{any-middle-org-codes}.{orgLeafCode} (account for periods in role values)
    ex. affiliation.add.staff.ES.ES-1
    ex. affiliation.add.staffstudent.ES.ES-2
   {
      "addAffiliation" : {
         "messageData" : {
            "uhUuid" : "12345678",
			"affID" : (check UHIMS - use perspositionID)"23432",
                "orgHierarchy" : [
               {
                  "code" : "TI",
                  "description" : "Technical Infrastructure"
               },
               {
                  "code" : "TI-SYS",
                  "description" : "TI - Systems Services"
               },
               {
                  "code" : "TI-SYS-MID",
                  "description" : "TI-SYS-MID"
               }               
            ],
		    "role" : "staff",
possibly a list
		    "officeLocation" : [
			{
				"building" : ITC,
				"floor" : 6,
				"cubicle"}] look: at UHIMS phones / list of "phone" (ask Dana where she updates the phone number - does she update ITSADMIN and WPMS)610
			}
			],
		    "phonesAsEntered" : "(808) 555-9128",
		    "faxesAsEntered" : "(808) 555-9130"
         }
      }
   }


Code Block
ROUTING KEY: subAffiliationaffiliation.modify.itsadmin{role}.{orgRootCode}.{any-middle-org-codes}.{orgLeafCode}.{role} (account for periods in role values) 
keep message to affiliation.modify.staff and provide what has changed
messageDataBefore
publisher confirm
onAck means that it was published

   
	{
      "modifyAffiliation" : {
         "messageData" : {
            "uhUuid" : "12345678",
required
			"affID" : required
            "orgHierarchy" : [
               {
                  "code" : "TI",
                  "description"23432",
		    "phonesAsEntered" : "Technical Infrastructure(808) 555-5555"
               },
               {
                  "code" : "TI-SYS",
                  "description" : "TI - Systems Services"
               },
               {
   
		 "messageDataBefore" : {
              "codeuhUuid" : "TI-SYS-MID",
                  "description" : "TI-SYS-MID"
               }               
            ]
		    "role" : "staff.noDetails12345678",
		    "beginDate" : "2015-12-25",
		    "endDateaffID" : "",
		    "officeLocation" : "ITC-Floor 6 / 60223432",
		    "phonesAsEntered" : "(808) 555-9128",
		    "faxesAsEntered" : "(808) 555-9130"
         }
      }
   }


Code Block
ROUTING KEY: subAffiliationaffiliation.delete.itsadmin{role}.{orgRootCode}.{any-middle-org-codes}.{orgLeafCode}.{role} (account for periods in role values) 
provide everything that we provide for the add
   {
      "deleteSubAffiliationdeleteAffiliation" : {
         "messageData" : {
            "uhUuid" : "12345678",
            "orgHierarchy			"affID" : [
               {
                  "code" : "TI",
                  "description" : "Technical Infrastructure"
               },
               {
                  "code" : "TI-SYS",
                  "description" : "TI - Systems Services"
               },
               {
                  "code" : "TI-SYS-MID",
                  "description" : "TI-SYS-MID"
               }               
            ]"23432",
		    "role" : "staff"
         }
      }
   }