|
|
The technician attributes along with their actions should be used as
defined below.
|
Note
|
1. The technician operations that can be performed through API are adding, updating and deleting. 2. Only technicians with roles of SDAdmin and SDSiteAdmin can perform add, update and delete operations. 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. |
The details necessary for adding a technician should be set in HttpRequest parameters and Httprequest parameter value for operation attribute should be 'AddTechnician'.
|
Attributes |
Comments |
|
targetURL= "/servlets/TechnicianServlet" |
target URL for Adding technician |
|
operation='AddTechnician' |
operation command for Adding technician. |
|
name |
Technician name |
|
employeeId |
Employee ID of the technician |
|
|
Email Address of the technician |
|
phone |
Phone Number of the technician |
|
mobile |
Mobile number of technician |
|
smsMailId |
SMS mail id of technician |
|
costPerHr |
technician's cost per hour |
|
departmentName |
department name to which the technician is associated to. |
|
techSiteName |
site name to which the technician is associated to. |
|
jobTitle |
Job title of the technician. |
|
associateSites |
Associated sites of the technician |
|
associateGroups |
Associated groups of the technician |
|
approvePurchaseOrder |
Purchase Order Approver |
|
UDF aliases name |
additional fields should be specified based on their column names |
|
enableLogin |
parameter for Enable Login for Technician |
|
loginName |
Technician's login name |
|
pwd |
Technician's password |
|
userDomainName |
Domain to which the technician belongs to |
|
associateRols |
roles associated with the technician |
|
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:
If the technician is associated to many sites, the sites should be specified in comma separated format in 'associateSites' say, India, US, London.
If the technician is assigned to more than one group, the groups should be specified in comma separated format in 'associateGroups' as sitename-groupname'.
If the technician is 'Not associated to any site', specify the value as 'default' in 'associateSites'.
To assign a technician to a department of 'Not associated to any site ', 'techSiteName' should be specified as 'default'.
If invalid values are provided for 'departmentName' and 'techSiteName', then technician is associated to 'Not associated to any site'.
'approvePurchaseOrder' is enabled only when the email ID of the technician is specified. The values permitted for 'approvePurchaseOrder' are 'true' and 'false'. By default, the value is 'false'.
The values permitted for 'enableLogin' are 'true' and 'false'. By default, the value is 'false'.
If 'pwd' is not specified, the pwd for the technician is the same as the specified 'loginName'.
Login is not provided to the technician if 'loginName' is not specified.
Technicians with SDSiteAdmin privileges but restricted access permissions can add technicians only for their associated sites.
The sample form to add a new technician can be viewed here.
The html form is submitted to http://machinename:Portnumber/servlets/RequestServlet and a response in xml format displays Success message along with the User ID.
A failure message appears if,
a technician without admin privilege is trying to add a technician. [xml response]
A technician with restricted access is trying to create a technician not associated to his site. [xml response]
the specified technician login name already exists [xml response]
The details necessary for adding a technician should be set in HttpRequest parameters and Httprequest parameter value for operation attribute should be 'UpdateTechnician'.
|
Attributes |
Comments |
|
targetURL= "/servlets/TechnicianServlet" |
target URL for Updating technician. |
|
operation='UpdateTechnician' |
operation command for Updating technician. |
|
techUserName |
Technician Name to update |
|
techLoginName |
Login Name of the technician |
|
techDomainName |
Domain Name to which technician the technician belongs |
|
techEmailId |
Email ID of the technician |
|
userid |
Technician ID |
|
name |
Technician name |
|
employeeId |
Employee ID of the technician |
|
|
Email Address of the technician |
|
phone |
Phone Number of the technician |
|
mobile |
Mobile number of technician |
|
smsMailId |
SMS mail id of technician |
|
costPerHr |
technician's cost per hour |
|
departmentName |
department name to which the technician is associated to. |
|
techSiteName |
site name to which the technician is associated to. |
|
jobTitle |
Job title of the technician. |
|
associateSites |
Associated sites of the technician |
|
associateGroups |
Associated groups of the technician |
|
UDF aliases name |
additional fields should be specified based on their column names |
|
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:
While performing the edit operation, technicians are identified based on the order below,
The users are first identified based on the 'techLoginName' and 'techDomainName'.
If the 'techDomainName' is not specified, the user is identified based on the 'techLoginName' with 'techDomainName' as an empty value.
If the technician does not fall under the above criteria, the user is identified based on the 'techEmailid'.
If the technician is unavailable in the above specified criteria, the technician is identified based on the 'techUserName'.
If the technician cannot be identified from the above criteria, then the technician is identified based on 'userid'.
Based on the reqUserName or reqEmailId, if more than one technicians are identified then the technician details is neither updated nor deleted.
Login details and 'approvePurchaseOrder' value cannot be updated through API.
Technicians with SDSiteAdmin privileges but restricted access permissions can add technicians only for their associated sites.
The sample form to update technicians can be accessed here.
A success message appears if the technician is updated successfully.
A failure message appears if,
A technician without admin privilege is trying to update a technician. [xml response]
A technician with restricted access is trying to update a technician not associated to his site. [xml response]
The details necessary for adding a technician should be set in HttpRequest parameters and Httprequest parameter value for operation attribute should be 'UpdateTechnician'.
|
Attributes |
Comments |
|
targetURL= "/servlets/TechnicianOperationServlet" |
target URLl for deleting technician |
|
operation='DeleteTechnician' |
operation command for deleting technician |
|
name |
Technician Name |
|
loginName |
Technician's Login Name |
|
domainName |
Technician's login domain name |
|
emailId |
Technician's email ID |
|
userid |
Technician ID |
|
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:
Technician with 'SDAdmin' can be deleted only by other 'SDAdmin'.
The sample form to delete a technician can be viewed here.
The response in xml displays a Success message if the technician has permission to delete technicians.
|
|
