Incident: Difference between revisions

Revision as of 17:43, 21 April 2015

See Incident Import Configuration for elements that can be used in import configuration.

XML Elements

Incident Sample

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

<!DOCTYPE Incidents SYSTEM "Incident.dtd"[]>

<!— The ExportData element is only used to display information about an export. No data is imported from these elements.

<!— This element will be present on all exported XML files.

</GeneratedBy>

<Login>JUser</Login>

</GeneratedBy>

</ExportData>

</ImportConfiguration>

<!— The Resources element is used only to display localization information. Data is not imported from these elements, so it is not necessary for XML imports. This element will be present on most exported XML files.

<!— LanguageCode must be a string

<!— ResourceID must be an Integer

<!— ResourceText must be a string. 1000 characters maximum

</Resources>

<IncidentID> TI-1 </IncidentID>

<Title> Test Incident </Title>

<!— During an import, the EntityID element is checked first and if no match is found the EntityName element is checked. If neither value matches an existing entity, the import will be stopped.

<Entity>

<!— EntityID must be an integer

<!— EntityName must be a String. 50 characters maximum.

<EntityName>XFRACAS Software</EntityName>

</Entity>

<Creator>

<!— FirstName must be a String. 80 characters maximum.

<!— MiddleName must be a String. 80 characters maximum.

<!— LastName must be a String. 80 characters maximum.

<!— Login must be a String. 100 characters maximum.

<Login>puser</Login>

</Creator>

<Owner>

<!— FirstName must be a String. 80 characters maximum.

<!— MiddleName must be a String. 80 characters maximum.

<!— LastName must be a String. 80 characters maximum.

<!— Login must be a String. 100 characters maximum.

<Login>suser</Login>

</Owner>

</AssignedProblems>

<!— Type must be a Serialized Incident, Simple Incident, or Part Incident.

<Type>

<!— Issue is required. It must be a valid Issue. Valid Issue is described in Common Elements.

<!— IssueTypeID must be set to 8 (Incident State) or 48 (Incident State Closed) if present.

<!— If the IssueTypeID is not specified it will be set to 8 (Incident State)

<Description>Serialized Incident</Description>

</Issue>

</Type>

<FirstName> Sally </FirstName>

</ASPFieldServiceTech>

<!— Day, Month and Year are required to be a valid date.

<!— All Dates imported should be in UTC or GMT+0, as all data stored in the database is in UTC.

<!— 4 Digit Integer.

<Year>2013</Year>

<!— Integer-including to and between 1 and 12.

<Month>6</Month>

<!— Integer-including to and between 1 and 31.

<Day>19</Day>

<!— Integer-including to and between 0 and 24.

<!— Integer-including to and between 0 and 60.

<!— Integer-including to and between 0 and 60.

<!— FormattedDate is a String and is for display information on an export only.

</OccuranceDate>

<!— 4 Digit Integer.

<Year>2013</Year>

<!— Integer-including to and between 1 and 12.

<Month>6</Month>

<!— Integer-including to and between 1 and 31.

<Day>19</Day>

<!— Integer-including to and between 0 and 24.

<!— Integer-including to and between 0 and 60.

<!— Integer-including to and between 0 and 60.

<!— FormattedDate is a String and is for display information on an export only.

</CreatedDate>

<!— PartID must be an integer. If left without a value, a new PartID will be assigned.

<!— If PartID value matches an existing PartID, the part will be updated.

<!— PartName must be a String. 255 characters maximum

<PartName>Synthesis Platform</PartName>

<!— PartNumber must be a String. 75 characters maximum

<PartNumber>SYN</PartNumber>

<!— Sets whether a part is retired. “Yes” means it’s retired. “No” means it’s not retired. Default setting is “No.”

<!— PartVersion must be a String. 50 characters maximum

<!— CreatedDate must be a Valid Date. Valid Date can be exemplified under Common Elements.

<!— UseExisting is required for a (Template) System. It must be “Yes” or “No.”

<!— If “Yes” an identical part that exists in the same entity will be used. If “No” a new part will always be inserted.

<!— Subpart is required to update a System. A Valid Part is required within a Subpart. See (Template) System.

<!— Entity must be a valid entity. Valid Entity can be exemplified under Common Elements.

<!— HID must be an integer. If present it must match an existing HID.

<!— When modifying System Part data, HID must not be used within Subparts in order for the System to update.

<!— SerialHID must be an integer. It is required for serialized incidents.

<!— For serialized incidents, the SerialHID and/or SerialNumber must match an existing top level serial system.

<!— When modifying System data, SerialHID must not be used within Subparts in order for the System to update.

<!— SerialNumber must be a string. It is required for serialized incidents.

<!— For serialized incidents, the SerialHID and/or SerialNumber must match an existing top level serial system.

<!— TimeMetric1 is a reliability time metric and does not inherently contain units. It is a floating (decimal) number.

<!— TimeMetric2 is a reliability time metric and does not inherently contain units. It is a floating (decimal) :number.

<!— TimeMetric3 is a reliability time metric and does not inherently contain units. It is a floating (decimal) number.

<!— Details are documented within Details.

</TopLevelPart>

<!— The ResponsibleParts element is required and must contain one or more ResponsiblePart elements.

<ResponsibleParts>

<!— ResponsiblePart must contain at least one Valid Part. Valid Part can be found in the Common Elements documentation.

<ResponsiblePart>

<Part>

<PartName> Action </PartName>

<PartNumber> Action </PartNumber>

<!— Set whether the ResponsiblePart is retired. Value should be Yes or No. Optional, default value is No.

</Part>

</ResponsiblePart>

</ResponsibleParts>

<!— Optional. Value must be Yes or No if present. The default value is “Null.”

<!— A value of “Yes” incidates the part is under warranty. A Value of “No” indicates it is not under warranty.

<!— Optional. Value must be Yes or No if present. The default value is “Null.”

<!— A value of “Yes” acts as if no warranty exists, even if it does. A Value of “No” acts as if a warranty exists, when it does.

<!— Optional. Value must be Yes or No if present. The default value is “Null.” This can be updated with a new value.

<!— A value of “Yes” shows that the customer requested feedback. A Value of “No” shows that the customer did not.

<!— Optional. Enter date in UTC time. This must be a Valid Date. Valid Date is defined in Common Elements.

</ServiceResponseDate>

<!— If an Address element contains any child elements, a combination of those values must match an existing address.

<!— Location is the only element that is required. An invalid City, State, Country, or ZipCode will be replaced by NULL.

<!— AddressLine1 is a String. 80 characters maximum.

<Address1>1450 South Eastside Loop</Address1>

<!— AddressLine2 is a String. 80 characters maximum.

<Address2>Address 2</Address2>

<!— City is a String. 50 characters maximum. Value must match an existing city.

<City> Tucson </City>

<!— State is a String. 80 characters maximum. Value must match an existing state.

<State> Arizona </State>

<!— StateAbbrev is a String. 2 characters maximum.

<!— Country is a String. 50 characters maximum. Value must match an existing country.

<Country> United States </Country>

<!— Zipcode is a String. 20 characters maximum.

<!— Location is a String. 80 characters maximum. Location must match an existing location.

<Location> ReliaSoft </Location>

<!— Entity must be a valid entity. Valid Entity can be exemplified under Common Elements.

</Address>

<!— At least 1 non-retired Status(State) is required. There can only be 1 Status element that has a Retired element with a value "No".

<Statuses>

<Status>

10

<Description> Under Review </Description>

</Issue>

<Date>

</Date>

<Login> JUSER </Login>

</UpdatedBy>

</Status>

<Statuses>

<Categories>

<Category>

<!— Issue is required. It must be a Valid Issue. Valid Issue is described in Common Elements.

<!— IssueTypeID must be set to 20 (Chargeable) or 21 (Non-Chargeable).

<Description> Cleanup </Description>

</Issue>

<!— A valid Date is required. Enter date in UTC time. A Valid Date can be seen in Common Elements.

<Date>

<Year>2013</Year>

<Month>6</Month>

<Day>17</Day>

</Date>

<!— {{APIComment|UpdatedBy follows Valid User Logic, that can be found in Common Elements.}

<Login> JUSER </Login>

</UpdatedBy>

<!— {{APIComment|Optional. If present must have value of "Yes" or "No". Default value is "No".}

<!— {{APIComment|A “Yes” sets Status to Retired. A “No” sets status to not Retired.}

<!— {{{1}}}

<Description> Send to Reman </Description>

</Issue>

</PartDisposition>

<!— Day, Month and Year are required to be a valid date.

<!— All Dates imported should be in UTC or GMT+0, as all data stored in the database is in UTC.

<!— 4 Digit Integer.

<Year>2013</Year>

<!— Integer-including to and between 1 and 12.

<Month>6</Month>

<!— Integer-including to and between 1 and 31.

<Day>19</Day>

<!— Integer-including to and between 0 and 24.

<!— Integer-including to and between 0 and 60.

<!— Integer-including to and between 0 and 60.

<!— FormattedDate is a String and is for display information on an export only.

</ChangeDate>

</RepairReplace>

</RepairReplaces>

<!— The Criticalities element is optional and may contain zero or more Criticality elements.

<Criticalities>

<Criticality>

<!— If Criticality is used, then SelectedCriticality is required.

<!— It must be a Valid Issue. Valid Issue is described in Common Elements.

</Issue>

</SelectedCriticalityIssue>

<!— CriticalityType is required.

<CriticalityType>

<!— The combination of CritTypeName and/or CritTypeDescription must match an existing criticality type.

<!— CritTypeName must be a String with 32 characters maximum.

<CritTypeName> Test Criticality </CritTypeName>

<!— CritTypeDescription must be a String with 100 characters maximum.

<CritTypeDescription> Criticality Description </CritTypeDescription>

</CriticalityType>

<!— CriticalityStep is an integer.

<!— CriticalityDisplayOrder is an integer.

</Criticality>

</Criticalities>

<Login>Buser</Login>

</MemberUser>

<Description> Software Engineer </Description>

</Issue>

</MemberRole>

</TeamMember>

<Login>pUser</Login>

</MemberUser>

<Description> Project Lead </Description>

</Issue>

</MemberRole>

</TeamMember>

</TeamMembers>

</Incident>

@@ Line 285: / Line 285: @@
 ::{{Template:XFRACAS.Blue|<[[Incident.Categories|'''Categories''']]>}}
 :::{{Template:XFRACAS.Blue|<[[Incident.Category|'''Category''']]>}}
+::::{{Template:XFRACAS.Blue|<!—}}{{APIComment|Issue is required. It must be a [[Valid Issue]]. Valid Issue is described in Common Elements.}}
+::::{{Template:XFRACAS.Blue|<!—}}{{APIComment|IssueTypeID must be set to 20 (Chargeable) or 21 (Non-Chargeable).}}
 ::::{{Template:XFRACAS.Blue|<[[Issue Element|Issue]]}}{{Template:XFRACAS.Red|IssueTypeID}}={{Template:XFRACAS.Black|"21"}}{{Template:XFRACAS.Blue|>}}
 :::::{{Template:XFRACAS.Blue|<[[Issue.Description|Description]]>}}Cleanup{{Template:XFRACAS.Blue|</[[Issue.Description|Description]]>}}
 ::::{{Template:XFRACAS.Blue|</[[Issue Element|Issue]]>}}
+::::{{Template:XFRACAS.Blue|<!—}}{{APIComment|A valid Date is required. Enter date in UTC time. A [[Valid Date]] can be seen in Common Elements.}}
 ::::{{Template:XFRACAS.Blue|<Date>}}
 :::::'''<font color=Blue><Year></font>2013<font color=Blue></Year></font>'''
@@ Line 297: / Line 300: @@
 :::::<font color=Blue><FormattedDate></font>06/17/2013 01:21 PM<font color=Blue></FormattedDate></font>
 ::::{{Template:XFRACAS.Blue|</Date>}}
+::::{{Template:XFRACAS.Blue|<!—}}{{APIComment|UpdatedBy follows [[Valid User]] Logic, that can be found in Common Elements.}
 ::::{{Template:XFRACAS.Blue|<UpdatedBy>}}
 :::::{{Template:XFRACAS.Blue|<FirstName>}}{{Template:XFRACAS.Black|Joe}}{{Template:XFRACAS.Blue|</FirstName>}}
@@ Line 302: / Line 306: @@
 :::::{{Template:XFRACAS.Blue|<Login>}}{{Template:XFRACAS.Black|JUSER}}{{Template:XFRACAS.Blue|</Login>}}
 ::::{{Template:XFRACAS.Blue|</UpdatedBy>}}
+::::{{Template:XFRACAS.Blue|<!—}}{{APIComment|Optional. If present must have value of "Yes" or "No". Default value is "No".}
+::::{{Template:XFRACAS.Blue|<!—}}{{APIComment|A “Yes” sets Status to Retired. A “No” sets status to not Retired.}
 ::::{{Template:XFRACAS.Blue|<Retired>}}{{Template:XFRACAS.Black|No}}{{Template:XFRACAS.Blue|</Retired>}}
+::::{{Template:XFRACAS.Blue|<!—}}{{APIComment|Chargeable is Export only. Since IsssueTypeID is equal to 21 (Non-Chargeable), “No” is displayed.}
 ::::{{Template:XFRACAS.Blue|<Chargeable>}}{{Template:XFRACAS.Black|No}}{{Template:XFRACAS.Blue|</Chargeable>}}
 :::{{Template:XFRACAS.Blue|</[[Incident.Category|'''Category''']]>}}

Incident: Difference between revisions

Revision as of 17:43, 21 April 2015

XML Elements

Incident Sample

Navigation menu

Search