|
The asset attributes along with their actions should be used as defined
below.
|
Note
|
1. The asset operations that can be performed through API are adding, updating and deleting assets. 2. Asset operations can be performed by technicians only with Inventory privilege. 3. The attributes are case sensitive and should be used as defined. 4. While renaming the button in the sample html form, specify 'operation' as hidden element. |
Add/Update Workstation and Server
The Details necessary for adding workstation should be set in HttpRequest parameters and HttpRequest parameter value for 'operation' attribute can be 'AddAsset','UpdateAsset' or 'SaveAsset'.
|
Attributes |
Comments |
|
targetURL= "/servlets/AssetServlet" |
Target URL for adding/updating workstation/server |
|
assetName |
Name of the asset (workstation/server) |
|
assetType |
asset Type |
|
model |
Model No. of the asset (workstation/server) |
|
productName |
Product Name of the asset (workstation/server) |
|
siteName |
Site to which workstation/server is associated |
|
ipAddress |
IP Address of workstation/server. |
|
serviceTag |
Service Tag of workstation/server |
|
wsManufacturer |
Workstation Manufacturer |
|
proCount |
Processor Count of workstation/server |
|
proType |
Processor Type of workstation/server |
|
proSpeed |
Processor Speed (in MHz) of workstation/server |
|
proManufacturer |
Processor Manufacturer of workstation/server |
|
ramSize |
RAM details (in MB) of workstation/server |
|
virtualCapacity |
Virtual Memory (in MB) of workstation/server |
|
osName |
Operating System Name of workstation/server |
|
osServicePack |
Operating System ServicePack of workstation/server |
|
resTag |
Resource Tag of workstation/server |
|
resSlNo |
Resource Serial No. of workstation/server |
|
barCode |
Bar Code of workstation/server |
|
location |
Location of workstation/server |
|
vendor |
Vendor of workstation/server |
|
acqDate |
Acquisition Date of workstation/server (Supported Format:yyyy-MM-dd) |
|
expiryDate |
Expiry Date of workstation/server (Supported Format:yyyy-MM-dd) |
|
warrantyExpDate |
Warranty Expiry Date of workstation/server (Supported Format:yyyy-MM-dd) |
|
assetState |
State of the of workstation/server |
|
assetToAssociate |
Associate the asset to other assets.(Valid only for Asset State 'In Use'). |
|
associateToUser |
Associate the asset to user.(Valid only for Asset State 'In Use'). |
|
associateToDepartment |
Associate the asset to department.(Valid only for Asset State 'In Use'). |
|
UDF Column Aliases |
UDF aliases name should be specified |
|
macAddress |
MAC Address of workstation/server |
|
nicInfo |
Nic Info of workstation/server |
|
netAddress |
Net Address of workstation/server |
|
domain |
Domain of workstation/server |
|
dnsServer |
DNS Server of workstation/server |
|
gateway |
Default Gateway of workstation/server |
|
dhcpEnabled |
is DHCP Enabled for workstation/server. Values allowed: true, false. Default value: false. |
|
monitorType |
Monitor Type of workstation/server |
|
monitorSerialNumber |
Serial Number of the monitor. |
|
monitorManufacturer |
Monitor manufacturer details |
|
mouseType |
Mouse Type of workstation/server |
|
mouseSerialNumber |
Serial Number of mouse |
|
mouseManufacturer |
Mouse manufacturer details |
|
keyboardType |
Keyboard Type of workstation/server |
|
keyboardSerialNumber |
Serial Number of keyboard |
|
keyboardManufacturer |
Keyboard manufacturer details |
|
username |
Login Name for SDP Authentication |
|
password |
Password for SDP Authentication |
|
DOMAIN_NAME |
Domain Name to which the user belongs |
|
logonDomainName |
Authentication Mode [AD or Local Authentication]. AD_AUTH refers to Active Directory Authentication. Local Authentication or empty value refers to Local Authentication. |
Note:
The 'assetName' is unique and hence cannot be duplicated and edited.
If 'ServiceTag' is specified, then the information provided for the workstation/server is considered only for that Service Tag and not for the specified asset name.
Product Type should be specified as the 'assetType'. This field is mandatory.
Product of the asset should be specified as the 'productName'.
If the specified 'model' or 'productName' is invalid or empty, then the model is created as 'Unknown ProductType' say, Unknown Workstation.
If the specified 'site' is invalid, the workstation/server is associated to 'Not associated to any site.'
If the specified 'vendor' is invalid and if the technician has permission to add a vendor, then the Vendor is created as specified by the user.
The Resource State should be specified in 'assetState'.
Workstations/Servers with the 'assetstate' as 'In Use', can be associated to departments, users or assets.
If the 'assetstate' is specified as 'In Use' then the values should be specified in the following fields, 'assetToAssociate','associateToUser' or 'associateToDepartment'.
If the assetState is 'In Use' and if the invalid values are provided for the following fields 'assetToAssociate','associateToUser' or 'associateToDepartment', the state is set to 'In Store'
Workstations/Servers in disposed state cannot be assigned users or departments.
Workstations/Servers in disposed state cannot be assigned with other assets.
Technician with restricted access can create/update workstations/servers only for their associated site.
Technician with restricted access can assign/ associate asset based on his access for that site alone.
To configure the asset additional fields for a workstation, specify the attribute as 'asset_LabelName'
Add Workstation/Server
The sample form to Add Workstations/Servers can be accessed here. The 'AddAsset' operation performs only the add operation.
The operation status is Success when the workstation/server is added successfully. The xml response also displays the 'resourceid' and the 'resourcename' along with the message. Click here to view the xml response.
The operation status is failure if
The mandatory fields are not specified
The technician with restricted access is trying to create a new workstation/server.
Update Workstation/Server
The sample form to Update Workstations/Servers can be accessed here. The 'UpdateAsset' operation performs only the update of existing assets with the information provided.
The operation status is Success when the workstation/server is updated successfully. Click here to view the xml response.
Save Workstation/Server
The sample form to Save Workstation/Server can be accessed here.
While performing SaveAsset operation, if the asset is already available with the specified criteria, the asset is updated. Else, a new asset is created with the information provided.
The details to add/update assets should be set in the Http Request parameters and the Http Request parameter value for 'operation' command can be 'AddAsset', 'UpdateAsset' or 'SaveAsset'.
|
Attributes |
Comments |
|
targetURL= "/servlets/AssetServlet" |
Target URL for adding/updating asset |
|
assetName |
Name of the asset |
|
assetType |
Type of asset |
|
productName |
Product Name of the asset |
|
siteName |
Site to which asset is associated |
|
assetTag |
Asset Tag |
|
resSlNo |
Serial No. of the asset |
|
barCode |
Bar Code of asset |
|
location |
Location of asset |
|
purchaseCost |
Purchase Cost of the asset |
|
vendor |
Vendor of asset |
|
acqDate |
Acquisition Date of asset |
|
expiryDate |
Expiry Date of asset |
|
warrantyExpDate |
Warranty Expiry Date of asset |
|
assetState |
State of the of asset |
|
assetToAssociate |
Associate the asset to other assets.(Valid only for Asset State 'In Use'). |
|
associateToUser |
Associate the asset to user.(Valid only for Asset State 'In Use'). |
|
associateToDepartment |
Associate the asset to department.(Valid only for Asset State 'In Use'). |
|
username |
Login Name for SDP Authentication |
|
password |
Password for SDP Authentication |
|
DOMAIN_NAME |
Domain Name to which the user belongs |
|
logonDomainName |
Authentication Mode [AD or Local Authentication]. AD_AUTH refers to Active Directory Authentication. Local Authentication or empty value refers to Local Authentication. |
Note:
The 'assetName' is unique and hence cannot be duplicated or edited.
Product Type should be specified as the 'assetType'. This field is mandatory.
Product of the asset should be specified as the 'productName'.
If the specified 'model' or 'productName' is invalid or empty, then the model is created as 'Unknown ProductType' say, Unknown Workstation.
If the specified 'site' is invalid, the workstation/server is associated to 'Not associated to any site.'
If the specified 'vendor' is invalid and if the technician has permission to add a vendor, then the Vendor is created as specified by the user.
The Resource State should be specified in 'assetState'.
Assets with the 'assetstate' as 'In Use', can be associated to departments, users or assets.
If the 'assetstate' is specified as 'In Use' then the values should be specified in the following fields, 'assetToAssociate','associateToUser' or 'associateToDepartment'.
If the assetState is 'In Use' and if the invalid values are provided for the following fields 'assetToAssociate','associateToUser' or 'associateToDepartment', the state is set to 'In Store'
Assets in disposed state cannot be assigned users or departments.
Assets in disposed state cannot be assigned with other assets.
Technician with restricted access can create/update Assets only for their associated site.
Technician with restricted access can assign/ associate asset based on his access for that site alone.
Add Asset
Click here to access the sample form.
The operation status is Success when the asset details are added successfully. The xml response also displays the 'asseteid' and the 'resourcename' along with the message. Click here to view the xml response.
The operation status is failure if,
The mandatory fields are not specified
The technician with restricted access is trying to create a new asset.
Update Asset
The sample form to Update Asset can be accessed here. The 'UpdateAsset' operation performs only the update of existing assets with the information provided.
The operation status is Success when the asset is updated successfully. Click here to view the xml response.
Save Asset
The sample form to Save Workstation/Server can be accessed here.
While performing SaveAsset operation, if the asset is already available with the specified criteria, the asset is updated. Else, a new asset is created with the information provided.
The details necessary for deleting assets should be set in HttpRequest parameters and Httprequest parameter value for operation attribute should be 'DeleteAsset'.
|
Attributes |
Comments |
|
targetURL="/servlets/AssetServlet" |
target URL for deleting asset |
|
assetName |
Name of the asset |
|
assetType |
type of asset |
|
username |
Login Name for SDP Authentication |
|
password |
Password for SDP Authentication |
|
DOMAIN_NAME |
Domain Name to which the user belongs. |
|
logonDomainName |
Authentication Mode [AD or Local Authentication]. AD_AUTH refers to Active Directory Authentication. Local Authentication or empty value refers to Local Authentication. |
The sample form to delete asset can be accessed here.
The operation status is a Success if the asset is deleted successfully. Click here to view the xml response.
|