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 or UPDATE existing Service Orders or INSERT new Service Order Actions.

...

The Keyword PREVIOUS assigns the current line of the Import File record to UPDATE the last successfully saved Order with a new Child Action.

CREATE

The Keyword CREATE assigns the current line of the Import File record to INSERT a new Service Order record.

PREVIOUS_ACTION

The Keyword PREVIOUS_ACTION assigns the line of the Import record to UPDATE the last successfully saved Action with new Child data such as the GLA.

...

Datatype is String.

See the Matches On section for information about allowable values.

...

Owner Department Hierarchy

Datatype is Hierarchical String or String.

The value for this field can be the full Hierarachial Path, or it can be just the last part of the Path. If you provide only the last part, then there is a chance that there could be duplicate values in the database. If duplicate values are found, then you will get an error.

...

Any other values will cause an error.

Default GLA

Datatype is Hierarchical String.

This sets the Action Default GLA in the Order's GLA tab.

Note: This is ignored if the SDA_ALLOW_MULTIPLE_DEFAULT_GLAS Configuration Option is set to True.

...

Service Order Action fields. These fields can be Required, Optional, or Not Allowed. This can depend on the Action Type. It is assumed all of these are optional unless specified differently.

Action

RequiredRequired if adding a Service Order Action.

...

Action Service ID

Conditionally Required

Datatype is String.

Not Required on Add Actions.

...

NOT allowed for use on Task Actions.

Action Service RECID

Datatype is Number.

Default is blank.

This is used to specify the Service Record for Services that have a blank Service ID.

If this is provided, the provided value must be a valid existing Service RECID.

If it is not, it will cause an error.

If an Action Service RECID value is provided, the Action Service ID field will be ignored.

Action Serv Catalog

Datatype is Hierarchical String.

Conditionally Required

Required on Add, Upgrade/Downgrade, and Task Actions.

...

Action Location

Conditionally Requiredfor Add Location Actions.

Conditionally Requiredfor Add Actions if the Service Catalog's Location Required flag is set to True.

Datatype is Hierarchical String.

NOT allowed for use on Task Actions.

...

Action Swap Service RECID

Datatype is Number.

Default is blank.

This is used to specify the Swap Service Record for Services that have a blank Service ID.

If this is provided, the provided value must be a valid existing Service RECID.

If it is not, it will cause an error.

If an Action Swap Service RECID value is provided, the Action Swap Service ID field will be ignored.

Action Reference

Datatype is String.

...

Action Owner Department Hierarchy

Datatype is Hierarchical String or String.

Takes precedence on the Action if an Owner is specified on the Order.

...

Action SLA Catalog

Datatype is Hierarchical String.

Must match the SLA Description field of an existing SLA Catalog.

...

Required for Add Actions with a Service Catalog type of Phone.

This field is optional for all Action types.

...

Datatype is String.

Conditionally Requiredif the provided Action Location Name exists with multiple Types.

...

NOT allowed for use on Task Actions.

See Service Order Imports Notes section of this wiki for more information about the behavior of this field.

...

NOT allowed for use on Task Actions.

See Service Order Imports Notes section of this wiki for more information about the behavior of this field.

...

NOT allowed for use on Task Actions.

See Service Order Imports Notes section of this wiki for more information about the behavior of this field.

...

NOT allowed for use on Task Actions.

See Service Order Imports Notes section of this wiki for more information about the behavior of this field.

...

Only set for Auth Code type Services.

See Service Order Imports Notes section of this wiki for more information about the behavior of this field.

...

Only set for Auth Code type Services.

See Service Order Imports Notes section of this wiki for more information about the behavior of this field.

...

Only set for Backbone and Data type Services.

See Service Order Imports Notes section of this wiki for more information about the behavior of this field.

...

The Rating Group field can only be used if it has been turned on in the configuration file.

See the Service Order Imports Notes section of this wiki for more information about the behavior of this field.

...

If the GLA is provided, it can apply to a Service Order record or to an Action. By default, the GLA data will always apply to the Service Order. The only way to make it apply to an Action is to use the "PREVIOUS_ACTION" keyword in the "SD Number" field. This means it will require at least two input lines to apply a GLA to an Action. One line to create the Action, and the next line(s) with the PREVIOUS_ACTION keyword and all blank Action fields to apply the GLAs.

GLA

Datatype is Hierarchical String.

If the GLA is blank, the GLA Expense Type, GLA Percent, and Default GLA Flag are all ignored.

...

"None" The Alias value will not be used at all.

ACTION_CABLE_ARRAY

If this flag is used, it must be assigned from an array in the Conditional Logic. An array is being used to allow you to specify multiple Cable operations on one input line. Here is an example of how to assign the flag, and all of the allowed array indexes for 2 Cable operations.

Code Block
languagephp
[FLAGS.ACTION_CABLE_ARRAY] = array(
    // first action, using csv fields 50-67
    array(
        "Flag" => [50],
        "Action" => [51],
        "Line_Number" => [52],
        "Notes" => [53],
        "Backbone_Service_ID" => [54],
        "Backbone_Service_Recid" => [55],
        "From_Eqp_ID" => [56],
        "From_Eqp_Location" => [57],
        "From_Eqp_Location_Type" => [58],
        "From_Port" => [59],
        "From_Port_Side" => [60],
        "Cable_Name" => [61],
        "Pair_Strand" => [62],
        "To_Eqp_ID" => [63],
        "To_Eqp_Location" => [64],
        "To_Eqp_Location_Type" => [65],
        "To_Port" => [66],
        "To_Port_Side" => [67],
    ),
    // optional second action, using csv fields 68-85
    array(
        "Flag" => [68],
        "Action" => [69],
        "Line_Number" => [70],
        "Notes" => [71],
        "Backbone_Service_ID" => [72],
        "Backbone_Service_Recid" => [73],
        "From_Eqp_ID" => [74],
        "From_Eqp_Location" => [75],
        "From_Eqp_Location_Type" => [76],
        "From_Port" => [77],
        "From_Port_Side" => [78],
        "Cable_Name" => [79],
        "Pair_Strand" => [80],
        "To_Eqp_ID" => [81],
        "To_Eqp_Location" => [82],
        "To_Eqp_Location_Type" => [83],
        "To_Port" => [84],
        "To_Port_Side" => [85],
    ),
);

Using this array method, any number of Cable operations can be provided.

Following is a list of the array indexes that are allowed. All of these are optional except for the "Flag".

"Flag"

This value is Required for any Cable operation. This tells the import process what you are trying to do. Allowed values are: Add, Edit, Delete, DeleteAdds, DeleteAll.
Use the Add flag to add new Cable actions.
Use the Edit flag to edit specific existing Cable actions. You should also specify an Action and Line Number to determine what Cable action to edit.
Use the Delete flag to delete specific existing Cable actions. You should also specify an Action and Line Number to determine what Cable action to edit.
Use the DeleteAdds flag to delete all existing Cable add actions from the Service Order Action.
Use the DeleteAll flag to delete all existing Cable actions from the Service Order Action.

Note that when any Service Order Action is created on an existing Service, all of the existing Cable information on that Service is automatically added to that Service Order Action. These flag operations can be used to modify those existing values.

"Action"

Type of Cable Action. Allowed values are Delete, Out Backbone, Add, In Backbone.
This index is only used for Edit and Delete lookups. Any new lines are automatically Add actions. If this is not provided, it will default to "Add".

"Line_Number"

When Adding a Cable action, this is optional. If it is not provided, then the system will calculate the next Line Number.
When Editing or Deleting, this can be used to find the Cable action you want to affect. This is not needed if there is only one Cable action to pick from.

"Notes"

Cable Path Notes.

"Backbone_Service_ID"

An existing Backbone Service ID to add to a Cable Path.

"Backbone_Service_Recid"

An alternate method to specify an existing Backbone Service, useful if the Service ID is blank.

"From_Eqp_ID"

Cable Path From Equipment ID.

"From_Eqp_Location"

From Equipment Location, useful if the Equipment ID is not unique.

"From_Eqp_Location_Type"

From Equipment Location Type, useful if the Location Name is not unique.

"From_Port"

From Equipment Port.

"From_Port_Side"

From Equipment Port Side. This is required if a From Port is specified.

"Cable_Name"

Cable Name to attach to the Path.

"Pair_Strand"

Pair/Strand to attach to the Path. If this is specified, then the Cable Name is also required.

"To_Eqp_ID"

Cable Path To Equipment ID.

"To_Eqp_Location"

To Equipment Location, useful if the Equipment ID is not unique.

"To_Eqp_Location_Type"

To Equipment Location Type, useful if the Location Name is not unique.

"To_Port"

To Equipment Port.

"To_Port_Side"

To Equipment Port Side. This is required if a To Port is specified.

Errors

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 : Invalid provided Service Rep name <firstName> <lastName>
    • Error : Invalid provided Service Rep Customer Number <customerNumber>
    • Error : Invalid provided Default Owner name <firstName> <lastName>
    • Error : Invalid provided Default Owner customer number <customerNumber>
    • Error : Invalid provided Requestor name <firstName> <lastName>
    • Error : Invalid provided Requestor Customer Number <customerNumber>
    • Error : Invalid provided Action Owner name <firstName> <lastName>
    • Error : Invalid provided Action Owner Customer Number <customerNumber>
    • Error : Invalid Default Owner Dept Hierarachy '<deptHierarchy>'
    • Error : Invalid Action Owner Dept Hierarachy '<deptHierarchy>'
    • Error : Invalid Service Order Number '<SD_NUMBER>'
    • Error : Invalid Default GLA '<DEFAULT_GLA>'
    • Error : Invalid Service Catalog '<SERV_CATALOG>'
    • Error : Invalid Swap Service ID '<SWAP_SERVICE>'
    • Error : Invalid SLA Catalog '<SLA_CATALOG>'
    • Error : Invalid Service Host '<SERVICE_HOST>'
    • Error : Invalid Location '<LOCATION>'
    • Error : Invalid SDC '<SDC>'
    • Error : Invalid Service ID
    • Error : Invalid GLA '<gla>'
    • Error : Invalid Action Location Type '<LOCATION_TYPE>'
    • Error : Invalid Associated Project '<PROJECT>'
    • Error : Associated Project '<PROJECT>' is Invalid Parent Service Desk Type


  2. The value provided from another table is Inactive

    Toggle cloak


    Cloak
    • Error : Inactive Service Catalog '<SERV_CATALOG>'
    • Error : Action Owner Contact <CONTACT> is Inactive
    • Error : Action Owner Dept Hierarchy '<DEPT_HIERARCHY>' is Inactive
    • Error : Default GLA '<GLA>' is Inactive
    • Error : Default Owner Contact <CONTACT> is Inactive
    • Error : Default Owner Dept Hierarchy '<DEPT_HIERARCHY>' is Inactive
    • Error : Inactive Service Catalog '<SERVICE_CATALOG>'


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

    Toggle cloak


    Cloak
    • Error : Service Rep is blank for new Service Order record
    • Error : No Service ID specified
    • Error : Missing Required Service Catalog value for Add or Upgrade action
    • Error : Missing Service ID for Action
    • Error : Service Host is required for Phone Add Actions
    • Error : Missing required Location for Add Action for this Service Catalog
    • Error : New Service ID provided for non Service ID Action
    • Error : Swap Service ID provided for non Swap Action
    • Error : Some GLA Percents are blank
    • Error : Blank GLA


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

    Toggle cloak


    Cloak
    • Error : SDC '<SDC>' is not valid for this Action
    • Error : Service Catalog <SERV_CATALOG> is not assignable
    • Error : Provided Service Host not permitted for this Service Catalog
    • Error : Provided Location not permitted for this Service Catalog
    • Error : Existing Service ID is not Available for Add Action
    • Error : The parent Service Order has a status of <Void, Complete, Finalized, or Billed>. No other Actions may be added to this Order.
    • Error : Provided Location not permitted for this Service Catalog
    • Error : Service Catalog does not match Service pool
    • Error : Service Catalog Service ID formats do not match
    • Error : Different count of GLAs and GLA percents
    • Error : Some GLA Percents are out of range (1 to 100)
    • Error : Some GLA Percents are not whole numbers
    • Error : GLA Percents do not add up to 100
    • Error : The Import process cannot Import that Action Type at this time
    • Error : Dept Hierarchy Owner provided for non Add or Owner Change action
    • Error : Location Cannot be provided to Remove or Swap actions
    • Error : SD Number PREVIOUS specified but no previous successful save
    • Error : SD Number PREVIOUS_ACTION specified but no previous successful Action save
    • Error : Service Catalog <SERV_CATALOG> does not match existing Service ID
    • Error : Service Catalog types do not match
    • Error : Previous Service Order save failed, so cannot save Service Order GLA
    • Error : Previous Service Order Action save failed, so cannot save action GLA
    • Error : Previous Service Order save failed, so cannot save Service Order GLA
    • Error : Previous Service Order Action save failed, so cannot save action GLA
    • Error : Dept Hierarchy Owner provided for non Add or Owner Change action
    • Error : Location Cannot be provided to Remove or Swap actions


  5. The System was unable to save the record

    Toggle cloak


    Cloak
    • Error : Failed to save Service Order record; <errorMessage>
    • Error : Failed to save Service Order Action record; <errorMessage>
    • Error : Failed to save Service Order GLA record; <errorMessage>

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


Notes
Anchor
Notes
Notes

The Service Order Source field CANNOT be set in Import. It is automatically set to Import on INSERT and unchanged for UPDATE.

...

User Defined Fields on any given Import are all handled the same way with Conditional Logic. For more information about adding a UDF to the Import see, the (2024.1) User Defined Fields section of the Imports main page. When Service Order Upgrade/Downgrade Actions are created by the Import, the "old" UDF values from the Service are automatically stored on the Action record.

Child pages (Children Display)
styleh6
sorttitle