Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.
Table of Contents
outlinetrue
stylenone

Capability

This Import allows the User to INSERT new records or UPDATE Services, Equipment, Ports/Pins/Lens, and Cable Paths all in one pass.

...

Excerpt

The Full Path import can create records for 'Path', 'Path Legs', 'Locations', 'Equipment' (from and to, each leg), 'Services', 'Ports/Pins/Lens' (from and to, each leg) and 'Vlans'. Each of these needs to check to see if the record it is trying to save already exists.

 Here is a list of the fields used to match existing records.

  • For Paths: Service ID, and/or Location Name and Location Type.

  • For Services: Service ID or Services RECID.

  • For Location of the Path: Location Name and Location Type, or Location of the Path Legs.

  • Location of the Path Leg From Equipment.

  • Location of the Path Leg To Equipment.

  • Path Leg From Equipment.

  • Path Leg To Equipment.

  • Path Leg From Equipment Ports/Pins/Len.

  • Path Leg To Equipment Ports/Pins/Len.

  • Vlan

Fields

Location Name

Required

Datatype is Hierarchical String.

If the Location does not exist, the Import will INSERT a new record.

...

Location Type

Conditionally Requiredwhen the Import is attempting to INSERT the Location.

Datatype is Hierarchical String.

Permitted values are from (2024.1) List Values of type LOCATION_TYPE: Site, Building, Floor, Room, Cube, Truck, Closet, Rack, Elevation, or Manhole.

...

Service Catalog

Datatype is Hierarchical String.

Conditionally Required if the Import is attempting to INSERT.

...

Datatype is String.

Conditionally Required if the Import is attempting to INSERT.

Service Owner

Datatype is Hierarchical String.

Conditionally Required if the Import is attempting to INSERT.

...

Datatype is String.

Service GLA

Datatype is Hierarchical String.

The Default value is blank.

...

ADD_EQUIPMENT:

Default Value is False.

  • True: If True, INSERT To Equipment and From Equipment when there is not an existing Equipment record.

  • False: If False, an error generates when the Equipment does not exist.

RECREATE_EXISTING_PATH:

Default Value = False

  • True: If a Cable Path already exists on the Service or Location, UPDATE all existing Paths with the Path value in the Import File.

  • False: If a Cable Path already exists, the Import generates an error.

REPLACE_IP:

Default Value False.

  • True: Allows the IP Address of Equipment to UPDATE when the Import File record has a different value.

  • False: Causes an error when the IP Address doesn't match.

REPLACE_VLANS:

Default Value False.

  • True: If True, when a VLAN is already assigned to a Port, UPDATE all the previously existing VLANs on that Port with the record from the Import File.

  • False: If False, append VLANs into the list of VLANs for that Port.

LOOKUP_PATH_BY_EQUIPMENT:

Default Value False.

  • True: Sets the Import to try to match the existing Equipment ID and its full Location path.

  • False: When the flag is False, the Lookup is done by the Service ID.

Legs Array

The real magic of the Cable Paths Full Import is the Legs Array field. This field cannot be assigned in the field mappings. It must be set in the Conditional Logic because it must be assigned to a PHP associative array of values containing the possibly multiple Legs of the Cable Path. For each Path Leg, the User is required to specify the Location Name, Type, From Equipment, To Equipment, Port, and optional VLAN. If any of these Locations, Equipment, Ports, or VLANs do not exist, the Import will INSERT them.

...

The following indexes are indexes in the FROM and TO arrays not the PATH_LEG array.
"EqpCatalog" => Equipment Catalog Name

Conditionally Required and only used when Import is attempting to INSERT the Equipment.

...

The best way to describe how to do this is by example. This example creates two Path Legs: Jack to Panel and Panel to Switch. The strings that are in double quotes are associative array indexes, and they must be written exactly as they appear in this example. The values after the '=>' operators can be literal strings, they can come from the input CSV file using the index syntax, or come from Conditional Logic variables that were previously assigned. We noticed it is slightly more readable when we assign the input values to variables before doing the path_leg assignments.

...

When an Import Line fails, it is usually because the Line falls into one of the following categories:

  1. The value provided from another table was not found within the Database

    Toggle cloak


    Cloak
    • Error : Couldn't find GLA <pathsServiceGla> for Service Id <pathsServiceID>
    • Error : Unable to find from equipment <from_EqpId> at Location <from_EqpLocationName>; <errorMessage>
    • Error : Unable to find to equipment <to_EqpId> at Location <to_EqpLocationName>; <errorMessage>
    • Error : Services RECID is invalid
    • Error : Invalid from Equipment Location <pathLeg_from_EqpLocationName>; ID=<pathLeg_from_EqpId>
    • Error : Invalid to Equipment Location <pathLeg_to_EqpLocationName>; ID=<pathLeg_to_EqpId>
    • Error : Invalid from Equipment ID=<pathLeg_from_EqpId> Location=<pathLeg_from_EqpLocationName>
    • Error : Invalid to Equipment ID=<pathLeg_to_EqpId> Location=<pathLeg_to_EqpLocationName>
    • Error : Invalid Cable Name <pathLeg_CableName>
    • Error : Invalid Pair/Strand <pathLeg_PairStrand> for cable <pathLeg_CableName>


  2. The value provided from another table has at least one existing Path

    Toggle cloak


    Cloak
    • Error : Service <serviceId> has multiple existing Paths
    • Error : Location <pathsLocationName> has multiple existing Paths
    • Error : Location <pathsLocationName> already has a Path


  3. A blank value was provided, for a field with a required value

    Toggle cloak


    Cloak
    • Error : Missing Service ID and Location - one is required
    • Error : Missing Path Legs Array
    • Error : No Service or Location for Path.
    • Error : Missing Equipment Catalog <from_equipment_EqpCatalog> for from equipment id <from_equipment_EqpId>
    • Error : Missing Equipment Catalog <to_equipment_EqpCatalog> for to equipment id <to_equipment_EqpId>


  4. The value provided is not acceptable for the record type being created

    Toggle cloak


    Cloak
    • Error : This Service has status 'Order Pending', so no updates allowed
    • Error : Service <serviceId> already has a Path
    • Error : Path leg <pathLegIndex> from equipment <importPathLeg_from_EQP> existing properties are different
    • Error : Path leg <pathLegIndex> to equipment <importPathLeg_to_EQP> existing properties are different


  5. The System was unable to save the record

    Toggle cloak


    Cloak
    • Error : Couldn't process path Location <pathsLocationName>; <errorMessage>
    • Error : Couldn't update Service Id <pathsServiceID>
    • Error : Couldn't save Service Id <pathsServiceID>; <$errorMessage>
    • Error : Couldn't update from equipment <PathLeg_from_EQUIPMENT_RECID> to IP <PathLeg_from_IP; <errorMessage>
    • Error : Couldn't update to equipment <PathLeg_to_EQUIPMENT_RECID> to IP <PathLeg_to_IP; <errorMessage>
    • Error : Couldn't process Path <serviceId> <locationId>; <errorMessage>
    • Error : Couldn't process Path Leg Location <pathLeg_LocationName>; <errorMessage>
    • Error : Couldn't process from equipment <from_EqpId> Location <from_EqpLocationName>; <errorMessage>
    • Error : Couldn't process to equipment <to_EqpId> Location <to_EqpLocationName>; <errorMessage>
    • Error : Unable to add from equipment <from_EqpId> at Location <from_EqpLocationName>; <errorMessage>
    • Error : Unable to add to equipment <to_EqpId> at Location <to_EqpLocationName>; <errorMessage>
    • Error : Couldn't process from Equipment <from_EqpId> Remarks; <errorMessage>
    • Error : Couldn't process to Equipment <to_EqpId> Remarks; <errorMessage>
    • Error : Couldn't process Equipment <EqpId> Ports Information; <errorMessage>
    • Error : Couldn't process Leg <pathLeg_FROM_EQP_PPL_RECID> to <pathLeg_TO_EQP_PPL_RECID> <errorMessage>
    • Error : Couldn't update Service Id <pathsServiceID>; <errorMessage>
    • Error : Failed to create new Vlan <vlan>; <errorMessage>
    • Error : Failed to add new Vlan <vlan> to port; <errorMessage>

    If you experience any of these Errors, without another accompanying Message about what might have caused the Save Failure, please submit a Ticket to PCR.


Child pages (Children Display)
styleh6
sorttitle