Create Device Model from excel

Introduction
Let's start
First device model
First look
The simplest device
Add some optional information
Different type of device
Supported Layers tab
Add chassis to device model
Create Chassis Models
Add some optional information
Add chassis models to device
Add slot to chassis model 
Add simple slot 
Add subslots 
Add multislot compatibility relations
Add port to device model
Add first port
Add port with compatible pluggable module models
Add crossconnect
Add power port to device model
Add some optional information
Technical background

Introduction

With ModelsImportTool user can import devices models which will have ports, ports with pluggable module models, power ports,
supported layers, chassises, and their structures, slots and crossconnects.

For port user has available list of generic port models. List in defined in List of Generic Models supported by Resource Catalog
Team:.

To support this functionality user will fill standalone excel template - no connection to environment is needed to define proper
device models. All necessary structures (like slots, ports or chassises) will be created in the background while models will be
imported.

Let's start
To start user you just needs to Configure ModelsImportTool. Later copy from "ModelsImportTool\Templates" to "ModelsImportTool\excel"
and change name. For name you can use Files Naming. Open new excel file, you will see tabs:

Detail information - this tab contains basic information about this device like name, manufacture, size, part number.
Supported Layers - This tab contains layers supported by the device..
Chassis Models - Here you can create Chassis Models
Structure - chassis  - Here you can define the chassis that this device has
Structure - ports - here you can define all ports which this device has.
Structure - power ports - here you can define all ports which this device has.
Chassis structure - slots - here you can define slots for this device.
Crossconnects - this tab will be used for defining crossconnects between ports in this device.
Notes - this tab is whole for you. You can put here links to documentation, some graphics, photos.

First device model

First look
Open just created excel file and go to first tab - Detail information. You will see ~20 columns but at the beginning you just need to fill a
few of them to create first device. Attributes are divided into two sections: Mandatory attributes and Optional attributes.

Mandatory attributes are:

Mandatory attributes are:

Object Type - This field is an enum, here you can choose the Object type of the device model, it can be:
DeviceModel
DWDMDeviceModel
IPDeviceModel
PDHDeviceModel
RadioEquipmentModel
SDHSwitchModel

Device Name - name of your device.

Manufacturer - manufacturer for this device. You will chose this from list.
Equipment Type - Equipment type for this device. You will chose this from list. 
CompatibilityType - Compatibility type for this device. You will chose this from list. Any or Restricted.
IsBlackbox- True/False, flag to determine if device is a Blackbox or not.
Generate Graphics - True/False, flag for automatic creation fo graphic. By default it's true - who doesn't want to have graphic?
Device Library - also True/False, this flag is very important. You can set this to true, only if you are in  Resource Catalog team!.

The simplest device

Firstly please select object type of device and tytpe name of device, as you can see Generate Graphics is set automatically.

Then please chose Manufacturer from list:

set Equipment Type:

also set Compatibility Type, IsBlackbox and Device Library:

And that's it. Your first device model, now you can save this and export to json then import to environment.

Add some optional information

In the Optional attributes section you can set some additional information for his device:

Acronym - acronym of this device.

Part Number - part number of this device, this is special code from documentation which can be useful for user when he or she
wants to order device.
Description - some larger information which can be useful for user.
Width, Height, Depth - those attribute are in meters, here is validation so each dimension needs to be between 0 and 1. Example
values: 0.1, 0.44, etc.
Height [U] - This attribute is the Height calculated with Rack units measurement.
Maximum Power Consumption - how much power this device can use, it's in kW (By default it will be calcualted from Structure -
power ports).

Graphics Done - True/False. If Generate Graphics then Graphics Done is true. In some situation you can set Generate Graphics To
 Graphics Done - True/False. If Generate Graphics then Graphics Done is true. In some situation you can set Generate Graphics To
False because you want to do graphic manually. In this situation you should set Graphics Done to true.
Weight - weight of device in kilograms.
Weight Unit - not editable, set automatically to Kilograms if Weight is set.
Physical Dimensions Done - not editable, set automatically to True if Width and Height are set.
Structure Done - not editable, always true.

Different type of device

In Device Model Template you can create DeviceModel, DWDMDeviceModel, IPDeviceModel, PDHDeviceModel, RadioEquipmentModel or
SDHSwitchModel. To do that you need change value in ObjectType (this is an enum).

Supported Layers tab

In this sheet user can create Supported Layers Relations for a physical device model. For all type of physical device model, relations are
filled with default values, the same that are created in the system. user has an opportunity to create additional records or to
remove/modify the default ones. User will see a template like this:

Here user have the following columns to set:

Layer - Layer which given Model can Terminated or Model can be used in a Routing of the Layer
PathObjectType - Name of the Trail class (OSSName) which in combination with Layer fully describes what kind of Trail can be
terminated or in which routing Model can be used
Routing - True/Fasle. Routing Flag defines if Device of given Model can be used in a routing of the given Layer
Termination - True/False.Termination Flag defines if Device of given Model can terminate given Layerrnetto

Add chassis to device model

In this section we will focus on creating and adding chassis (with slots) to devices. Firstly we have tab  Chassis Models. In this tab user can
create the wanted chassis and add it later add to device in tab Structure - chassis, this tab is done by user to "set" the needed chassis into
device (This will be explained what happens if user create a chassis and do not use it in tab  Structure - chassis). Finally we have tab Chassis
structure - slots, in this tab user can set the slots in each chassis that he/she created in tab  Chassis Models.
Create Chassis Models
To create chassis you need to go to Chassis Models. You will see something like in the screen below. Just empty gray tab with only one field
to set. So let's start with putting name of our chassis.

Now you see that only optional attributes are ready to be set, but there is a validation field, warning you that Model is not used in
Structure - chassis tab, this means that this chassis is not set in the device, this part we will solve ass soon as we fill tab Structure - chassis.

Add some optional information

In the Optional attributes section you can set some additional information for this chassis:

Part Number - part number of this device, this is special code from documentation which can be useful for user when he or she
wants to order chassis.
Height, Depth - those attribute are in meters, here is validation so each dimension needs to be between 0 and 1. Example values:
0.1, 0.44, etc.
Height [U] - This attribute is the Height calculated with Rack units measurement.
Half Width and Half Depth - True/False, this field is set to true if chassis occupies half of the size of the device.
Weight - weight of chassis in kilograms.

Done! now you have one chassis in your template, the optional attributes you can set if you want.

Add chassis models to device

To add chassis to device you need to go to tab Structure - chassis. You will see something like in the screen below. Just empty gray tab with
only one field to set. So let's start with putting model of chassis.
Now we see that some fields need to be set and some was set be default.

Chassis Name - Name of the chassis in the device structure

PositionID - this is unique number, one set shouldn't be changed. If later you will change name, the PositionID will remains and
tool will know that this is still the same chassis, even with different name.
Level of Optionality  - It describes the level of optionality of chassis, it can be Fixed, Optional or Mandatory.
Fixed components defined in the Model cannot be removed on the level of the template. Every single Fixed component on
 Fixed components defined in the Model cannot be removed on the level of the template. Every single Fixed component on
the same level in the structure must have a unique name.
Optional components (e.g. a chassis extension in the model of a device or optional licences in the model of a card) do not
require unique names on the same level (e.g. an alternative optional chassis for a device).
Is Selected - It describes that occupied component is selected in the structure. Fixed chasssis is always Selected. And what does is
mean to be selected - it means that when user created instance of device he/she will create all selected chassises by default.

As you can see you can set more than one chassis structure, and yes, can be the same, but remember that name and positionID needs to
have unique values. With this you added your chassis to the device structure 

And remember that validation from Chassis Models tab ?

Since you used the created chassis in your device in tab Structure - chassis, this validation is OK now.

Add slot to chassis model 

Add simple slot 

Our device has ports so now we can focus next tab - Chassis structure - slots. In this tab we can easily add slots with list of compatibilities.
This tab is similar to port tab. We have columns:

Chassis Model - Model of chassis that you want to add the slot
Slot Name - name of this slot. It needs to be unique in one chassis model but two can have the same names of slots.
PositionID - position ID. Like for port.
Side - by default it will be set to Front. Slot can be also in the back of device.
Compatible cards - which card models are compatible with each slot. Later it will be shown.

and
and

SubSlot 1 Name
SubSlot 1 PositionID
SubSlot 1 Compatible Cards
SubSlot 2 Name
SubSlot 2 PositionID
SubSlot 2 Compatible Cards
Multislot compatibility relations

but we will focus only on first four, subslots will by described in next chapter.

We will put three slots to the same model, you can also put to the ones that you need:

Now we can focus on compatible cards - we will add them in the same way as we added to pluggable ports.

Now you have device with chassis and some and it has slots with some compatibilities to cards, now you can save excel and  export to json 
then import to environment.

Add subslots 
Now we will focus on subslots. Firstly why we have subslots? Sometimes to one slot we can put one card, but sometimes we can put some
half card or two smaller cards. We can't just replace one slot with two smaller slots because still we want to use this large card. In that case
we can define two subslots. It's important - slot can have none subslots or two subslots. To define subslots we just need to set names for
them like below.
Now slot ThirdOne has one compatible card and two subslots - subSlot1 and subSlot2. Position ID will be always 1 and 2. Side for subslots is
always the same like for main slot. Let's add compatibilities:

One subslot has two compatible cards and second has one compatible card. All three cards - one for main slot and two for subslots - have 
Slot Occupation 1, they still occupies one slot. As always you can save excel and export to json then import to environment.

Add multislot compatibility relations

For adding multislot compatibility relations please check out New concept of multislot compatibiliy relations. It describes old way of adding
those relations and new way. It works the same for slot in card and device. Some trailer:

Multislot compatibilities
Some device have many slots which are compatible with many card models. Sometimes some one instance of card model can
occupy more then 1 slot at the same time. Those cards have Slot Occupation set to 2-4. In that case when user want to insert
this card to one slot, he or she needs to select additional slots. Also when user model device model he/she needs to select all slot
for each compatibility. With excels for cards and devices concept has changed and make it much more easier for modeler. If card
has multislot compatibility we will internally call one slot model as Master Slot Model and rest as Slaves Slot Models.

In case of chassis slots, if user set, for example, "Slot2" in row of "Slot1", tool will take chassis model from "Slot1"

Add port to device model

Add first port
To add port you need to go to tab Structure - Ports. You will see something like in the screen below. Just empty gray tab with only one field
to set. So let's start with putting name of our port.
Now we see that some fields need to be set and some was set be default.

Port Model - this is model of our port, chose from the list. Ports are described here - List of Generic Models supported by Resource
Catalog Team:. Some port models are Pluggabled, that means you can put some pluggable module model to this port. For now we
will focus on normal port. Choose some not Pluggabled port model.
PositionID - this is unique number, one set shouldn't be changed. If later you will change name, the PositionID will remains and
tool will know that this is still the same port, even with different name.
Side - can be Front or Back. By default all ports are on the front of device model but you can put them to them back - it depends on
vendor documentation.

Let's add second port.

Done! We have device with two ports. If you do mistake - don't worry, excel validate if names or PositionID are unique.

Add port with compatible pluggable module models

Second type of ports are Pluggabled Port. Pluggabled Port are those with "Pluggable" in name. To add them do the same steps like for
regular port. If you choose port model with "Pluggabled" you will see the value in column "Is Pluggable" will become "true", and
Compatible Pluggable module models will be available.

Now we can add some compatibilities. Click cell and put compatible pluggable module models. For each put manufacturer of pluggable
model plus ";" (semicolon) plus name of pluggable module model. To add more then one compatible module model for one port you need
to add new line in cell (shortcut is Left Alt + Enter).
And that's it. You have device with ports and some of them have compatibilities to pluggable module model, now you can save excel and e
xport to json then import to environment.

Add crossconnect
If we add some port to device model then we can add crossconnects in the tab - Crossconnects. Firstly we have only one cell white so it's
easy to start

Let's add dome crossconnects. In this manual we will add 3 crossconnects. In first step we will choose Crossconnect Type. As you can see
in the picture below, for some crossconnect types Termination Point Layer will set automatically. For some it won't set automatically
because there will be more then ne option to peek. More information about Mandatory attributes:

Start Port - port which is beginning of crossconnect. This is an enum with list of ports from Structure - ports tab.
End Port - port which is end of crossconnect. This is an enum with list of ports from Structure - ports tab.
Termination Point Layer is an enum with layer which are correct for chosen Crossconnect Type. It will set automatically if one is
available.
Direction - You can choose Bidirectional or Unidirectional.

We set mandatory attributes, but still some optional attributes are marked. This happened because for all Crossconnect Types, except
Physical Crossconnect, Start and End Termination Points are obligatory.

In those two columns you need to put busisness key of termination points. You can check those business key at List of product port
models.

Let's set those termination points. You need to type: Termimination Point Type plus "-" plus Layer plus "-" plus suffix which needs to be
checked at List of product port models.

For Physical Crossconnect Start and End Termination Points are optional bu we can set this by putting business key of connectors.
The last column is for checking if some crossconnects are not duplicated. If everything is ok then we can save excel and  export to json then
 import to environment.

Add power port to device model

To add power ports to device you need to go to tab Structure - power ports. You will see something like in the screen below. Just empty gray
tab with only one field to set. So let's start with putting name of our power port . Here we wiil focus on the mandatory section first

Now we see that some fields need to be set and some was set be default.

PositionID - this is unique number, one set shouldn't be changed. If later you will change name, the PositionID will remains and
tool will know that this is still the same port, even with different name.
Connector Type - It describes the connector of the power port. The correct way to get this value from the environment is set the Id
entifier/Name
Power Type - Power type of the port, it can be AC or DC
Add some optional information
In the Optional attributes section you can set some additional information for this power port:

Names of connectors - Here you can set name of connectors separated by ";". Be careful you need to set the same number of
names as you put in number of connectors
Side - can be Front or Back. By default all ports are on the front of device model but you can put them to them back - it depends on
vendor documentation.
Power Direction  - It describes the power direction, by default is set to In but you can change to Out.
Minimum Nominal Voltage - It describes minimum nominal voltage on the power port. it's in V.
Maximum Nominal Voltage - It describes maximum nominal voltage on the power port. it's in V.
Maximum Power Consumption - This is the device maximum power consumption. it's in kW.
Max Power Capacity - Maximum amount of power that can be served via this port (for output ports).

Technical background