Versions Compared

Key

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

Capability

The Cable Path Import allows the User to INSERT a valid Cable Path with an Origination Equipment and a Destination Equipment record onto existing Cable. Cable Path is an association record that must have valid values before the User can create it for the Cable Name, Equipment, and Location fields. The Cable Path Import process CANNOT INSERT these records, they MUST already exist.

...

While the Service ID and the Location are optional, at least one of these must be provided to give the Path a valid location.

Service ID

Conditionally Required

Datatype is String.

Either a Service ID or a Location must be provided. The provided value can be formatted, unformatted, or it can be a Service Alias value.

...

This field can be used as an alternative to the Service ID field. This is especially useful to find a Service that has a blank Service ID.

Location

Conditionally Required

Datatype is Hierarchical String.

Either a Service ID or a Location must be provided. If both are provided, the Import uses both.

...

Location Type

Conditionally Required if the provided Location Name exists with multiple Types.

...

In order to put a Pair Strand on the Cable Path Leg, one of these two conditions must be true:

    • The Status of the Pair must be Spare.

    • The Pair must have its Multiple Paths flag set, and not have Status Bad.

From Equipment ID

Datatype is String.

...

The Cable Path Import will NOT INSERT Equipment IDs. This must be done with the Equipment Import, API, or manually create the Equipment record.

...

From Equipment Location

Datatype is Hierarchical String.

The From Equipment Location is only used to find the correct From Equipment. It is only needed if there is more than one From Equipment with the same Equipment ID in different Locations.

...

The Cable Path Import will NOT INSERT Port/Pin/Lens records. This must be done with the Ports/Pins/Lens (PPL), API, or manually create the PPL record.

...

If the lookup fails, it causes a warning. The Path is created with blank Port/Pin/Len values.

If the Port is already in use on a different Cable Path, then it must have its "Multiple Paths" flag set to true for it to be added to an additional Cable Path. If the Port is already in use and the "Multiple Paths" flag is not set, then an error will occur.

From Port Pin Len Side

Datatype is String.

...

The Cable Path Import will NOT INSERT Equipment IDs. This must be done with the Equipment Import, API, or manually create the Equipment record.

To Equipment Location

Datatype is Hierarchical String.

The To Equipment Location is only used to find the correct To Equipment. It is only needed if there is more than one To Equipment with the same Equipment ID in different Locations.

...

The Cable Path Import will NOT INSERT Port/Pin/Lens records. This must be done with the Ports/Pins/Lens (PPL), API, or manually create the PPL record.

...

If the lookup fails, it causes a warning, but the Path is created with blank Port/Pin/Len values.

If the Port is already in use on a different Cable Path, then it must have its "Multiple Paths" flag set to true for it to be added to an additional Cable Path. If the Port is already in use and the "Multiple Paths" flag is not set, then an error will occur.

To Port Pin Len Side

Datatype is String.

...

This field can be used as an alternative to the Backbone Service ID field. This is especially useful to find a Backbone Service that has a blank Service ID.

Leg Location

Datatype is Hierarchical String.

This is optional and used to assign the location of the Path Leg. Usually, this is not needed, and the location of the leg will match the location of the Path or the Path's Service. This is usually used to differentiate Path Legs for Services that have multiple Locations.

Leg Location Type

Conditionally Required if the provided Leg Location Name exists with multiple Types.

...

"FROM_EqpLocation"

"FROM_EqpLocationType"

"FROM_EqpPPLPort"

"FROM_EqpPPLSide"

...

"TO_EqpLocation"

"TO_EqpLocationType"

"TO_EqpPPLPort"

"TO_EqpPPLSide"

...

Here is an example of how this is done with a two-leg Path, from a switch to a panel then a panel to a jack. 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 recommend using the variables to make the logic slightly more readable and easier to maintain.

...

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
    • Warning : Invalid From Port/Pin/Len '<FROM_PORT_PIN_LEN>', side '<fromPPLSide>'
    • Warning : Invalid To Port/Pin/Len '<TO_PORT_PIN_LEN>', side '<toPPLSide>'
    • Error : Invalid Backbone Service ID '<BACKBONE_SERVICE_ID>'
    • Error : Invalid Location Type '<LOCATION_TYPE>'
    • Error : Invalid Leg Location Type '<LOCATION_TYPE>'
    • Error : Invalid Cable Name '<CABLE_NAME>'
    • Error : Invalid Cable Pair/Strand '<CABLE_NAME>' '<PAIR_STRAND_NUMBER>'
    • Error : Invalid From Equipment '<FROM_EQUIPMENT_ID>'
    • Error : Invalid To Equipment '<TO_EQUIPMENT_ID>'
    • Error : Invalid Service ID '<SERVICE_ID>'
    • Error : Invalid Location '<LOCATION>'


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

    Toggle cloak


    Cloak
    • Error : Missing From Equipment
    • Error : Missing Service ID / Location


  3. The System was unable to save the record

    Toggle cloak


    Cloak
    • Error : Failed to save Path record; <$errorMessage>
    • Error : Failed to save Path Leg record; <$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