XML Import Instructions
Instructions
Tango Import uses XML to import different items in the tango database. Each of the elements that can be imported is detailed below.
TangoObjectImport
The top level of the XML document is TangoObjectImport. There are no attributes associated with TangoObjectImport.
Example:
1 <TangoObjectImport></TangoObjectImport>
Unit is the top level element for the asset tree. It is a child of the TangoObjectImport element. The Unit element has the following attributes:
- PlantUnitID - Optional. The internal ID number identifying the unit in the database. If you are creating a new Unit, this attribute is optional. If you are updating an existing Unit, or any of its descendants, this attribute is required.
- UnitName - Required. The name of the Unit. If you specify this attribute for an existing unit, the Unit name will be updated to what is contained in the attribute.
- OrderValue - Optional. Specifies the order in which the Unit will be displayed in the asset tree in Tango.
- Decommissioned - Optional. Specifies whether the Unit is decomissioned. Decomissioned units and their children will not be displayed in the asset tree or show up in reports.
Example:
1 <TangoObjectImport>
2 <Unit PlantUnitID="93" UnitName="814 Hotline" Decommissioned="0" OrderValue="1"/>
3 </TangoObjectImport>
4
Function is a child of the Unit element. The Function element should be contained inside the Unit that is it's parent in the asset tree. Function has the following attributes:
- PlantFunctionID - Optional. The internal ID number identifying the function in the database. If you are creating a new Function, this attribute is optional. If you are updating an existing Function, or any of its descendants, this attribute is required.
- FunctionName - Required. The name of the Function. When this attribute is specified for an existing Function, the name will be updated.
- OrderValue - Optional. Specifies the order in which the Function will be displayed in the asset tree in Tango.
- Decomissioned - Optional. Specifies whether the function is decomissioned. Decomissioned functions and their children will not be displayed in the asset tree or show up in reports.
Example:
1 <TangoObjectImport>
2 <Unit PlantUnitID="93" UnitName="814 Hotline" Decommissioned="0" OrderValue="1">
3 <Function PlantFunctionID="101" FunctionName="CRN" OrderValue="1" Decomissioned="0"/>
4 </Unit>
5 </TangoObjectImport>
6
Asset is a child of the Function element. The Asset element should be contained inside the Function that is it's parent in the asset tree. Asset has the following attributes:
- PlantAssetID - Optional. The internal ID number identifying the asset in the database. If you are creating a new Asset, this attribute is optional. If you are updating an existing asset, or any of its descendants, this attribute is required.
- AssetDesc - Required. The name of the Asset. When this attribute is specified for an existing Asset, the name will be updated.
- AssetIDTag - Optional. The ID tag for the Asset. When specified in the element, the existing AssetIDTag is updated.
- Criticality - Optional. Specifies a criticality level for the Asset.
- CapacityImpact - Optional. Specifies the capacity impact of the Asset.
- CostImpactPerHour - Optional. Specifies the cost impact per hour (in dollars, #.##) of the Asset.
- WorstCaseFailureDowntimeInHours - Optional. Specifies the worst case failure downtime in hours of the Asset.
- AssetUsageTypeID - Optional. Specified the asset usage type of the Asset. Consult 24/7 before specifying this attribute.
- OrderValue - Optional. Specifies the order in which the Asset will be displayed in the asset tree in Tango.
- Decomissioned - Optional. Specifies whether the asset is decomissioned. Decomissioned assets and their children will not be displayed in the asset tree of show up in reports.
Example:
1 <TangoObjectImport>
2 <Unit PlantUnitID="93" UnitName="814 Hotline" Decommissioned="0" OrderValue="1">
3 <Function PlantFunctionID="101" FunctionName="CRN" OrderValue="1" Decomissioned="0">
4 <Asset PlantAssetID="345" AssetDesc="MILL" OrderValue="1" Decomissioned="0"/>
5 </Function>
6 </Unit>
7 </TangoObjectImport>
8
AnonymousLocation is a child of the Function element. The AnonymousLocation element should be contained inside the Function thatis it's parent in the asset tree. AnonymousLocation has the following attributes:
- PlantAssetID - Optional. The internal ID number identifying the AnonymousLocation in the database. If you are creating a new AnonymousLocation, this attribute is optional. If you are updating an existing AnonymousLocation, or any of its descendants, this attribute is required.
- AssetDesc - Required. The name of the AnonymousLocation. When this attribute is specified for an existing AnonymousLocation, the name will be updated.
- AssetIDTag - Optional. The ID tag for the AnonymousLocation. When specified in the element, the existing AssetIDTag is updated.
- Criticality - Optional. Specifies a criticality level for the AnonymousLocation.
- CapacityImpact - Optional. Specifies the capacity impact of the AnonymousLocation.
- CostImpactPerHour - Optional. Specifies the cost impact per hour (in dollars, #.##) of the AnonymousLocation.
- WorstCaseFailureDowntimeInHours - Optional. Specifies the worst case failure downtime in hours of the AnonymousLocation.
- OrderValue - Optional. Specifies the order in which the AnonymousLocation will be displayed in the asset tree in Tango.
- Decomissioned - Optional. Specifies whether the AnonymousLocation is decomissioned. Decomissioned assets and their children will not be displayed in the asset tree of show up in reports.
Example:
1 <TangoObjectImport>
2 <Unit PlantUnitID="93" UnitName="814 Hotline" Decommissioned="0" OrderValue="1">
3 <Function PlantFunctionID="101" FunctionName="CRN" OrderValue="1" Decomissioned="0">
4 <AnonymousLocation PlantAssetID="345" AssetDesc="MILL" OrderValue="1" Decomissioned="0"/>
5 </Function>
6 </Unit>
7 </TangoObjectImport>
8
GeneralStore is a child of the Function element. The GeneralStore element should be contained inside the Function that is it's parent in the asset tree. GeneralStore has the following attributes:
- PlantAssetID - Optional. The internal ID number identifying the GeneralStore in the database. If you are creating a new GeneralStore, this attribute is optional. If you are updating an existing GeneralStore, or any of its descendants, this attribute is required.
- AssetDesc - Required. The name of the GeneralStore. When this attribute is specified for an existing GeneralStore, the name will be updated.
- AssetIDTag - Optional. The ID tag for the GeneralStore. When specified in the element, the existing AssetIDTag is updated.
- Criticality - Optional. Specifies a criticality level for the GeneralStore.
- CapacityImpact - Optional. Specifies the capacity impact of the GeneralStore.
- CostImpactPerHour - Optional. Specifies the cost impact per hour (in dollars, #.##) of the GeneralStore.
- WorstCaseFailureDowntimeInHours - Optional. Specifies the worst case failure downtime in hours of the GeneralStore.
- OrderValue - Optional. Specifies the order in which the GeneralStore will be displayed in the asset tree in Tango.
- Decomissioned - Optional. Specifies whether the GeneralStore is decomissioned. Decomissioned assets and their children will not be displayed in the asset tree of show up in reports.
Example:
1 <TangoObjectImport>
2 <Unit PlantUnitID="93" UnitName="814 Hotline" Decommissioned="0" OrderValue="1">
3 <Function PlantFunctionID="101" FunctionName="CRN" OrderValue="1" Decomissioned="0">
4 <GeneralStore PlantAssetID="345" AssetDesc="MILL" OrderValue="1" Decomissioned="0"/>
5 </Function>
6 </Unit>
7 </TangoObjectImport>
8
AssetComponent is a child of the Asset element. The AssetComponent element should be contained inside the Asset that is its parent in the asset tree. AssetComponent has the following attributes:
- PlantAssetCompID - Optional. The internal ID number identifying the AssetComponent in the database. If you are creating a new AssetComponent, this attribute is optional. If you are updating an existing AssetComponent, or any of an existing AssetComponent's descendants, this attribute is required.
- AssetCompName - Required. The name of the AssetComponent. When this attribute is specified for an existing AssetComponet, the name will be updated.
- AssetCompType - Required. Specifies the component type of the asset (ie. Motor - AC Induction). The name of the asset component type must match an asset component type in the Tango database. If an asset component type with the same name appears in more than one asset component class, then the class must be specified as well.
- AssetCompClass - Optional/Required. Specifies the class to which the component type belongs. If the specified component type exists in more than one class, then this attribute is required. Otherwise, the class is optional.
- Criticality - Optional. Specifies the criticality of the component.
- LocationMeanTimeBetweenFailureInDays - Optional. Specifies the MTBF of the component in days.
- OrderValue - Optional. Specifies the order in which the AssetComponent will be displayed in the asset tree in Tango.
- Decomissioned - Optional. Specifies whether the AssetComponent is decomissioned. Decomissioned AssetComponents and their children will not be displayed in the asset tree of show up in reports.
- AddAnonymousEquipmentHistoryEntry - Optional. Specifies whether the import process should generate an anonymous piece of equipment to install in the location during the import. This is a bit type, the value should be 1 or 0.
Example:
1 <TangoObjectImport>
2 <Unit PlantUnitID="93" UnitName="814 Hotline" Decommissioned="0" OrderValue="1">
3 <Function PlantFunctionID="101" FunctionName="CRN" OrderValue="1" Decomissioned="0">
4 <Asset PlantAssetID="345" AssetDesc="MILL" OrderValue="1" Decomissioned="0">
5 <AssetComponent PlantAssetID="1000" AssetCompName="MOTOR" AssetCompType="Motor - AC Induction" AssetCompClass="Motors"/>
6 </Asset>
7 </Function>
8 </Unit>
9 </TangoObjectImport>
10
StateObservationLocation is a child of the Asset element and represents a state observation that is an asset component (as opposed to a state observation parameter, which is a child of an Asset). The StateObservationLocation element should be contained inside the Asset element that is its parent. StateObservationLocation has the following attributes:
- StateHistoryGroupName - Required. This attribute designates the state history group that is associated with the state observation location.
- ObservationDescription - Optional. Typically, this attribute is used to add descriptive information or instructions that will show up on mobile devices when the state observation is used on a route.
- PlantAssetCompID - Optional. The internal ID number identifying the AssetComponent in the database. If you are creating a new AssetComponent, this attribute is optional. If you are updating an existing AssetComponent, or any of an existing AssetComponent's descendants, this attribute is required.
- AssetCompName - Required. The name of the AssetComponent. When this attribute is specified for an existing AssetComponet, the name will be updated.
- OrderValue - Optional. Specifies the order in which the AssetComponent will be displayed in the asset tree in Tango.
- Decomissioned - Optional. Specifies whether the AssetComponent is decomissioned. Decomissioned AssetComponents and their children will not be displayed in the asset tree of show up in reports.