Configuring the Web Service for Windchill Nonconformance
The Windchill Nonconformance web service (WcNonconformanceIfc) is deployed out-of-the-box with Windchill default authentication. Because of this authentication, the user of the web service must be a valid Windchill user.
Updating the Security Policy
If you want to modify the security policy, you must redeploy the web service with the appropriate security policy. If no security policy is specified while you are redeploying, the system selects the security policy from the security.properties file located in <Windchill>\bin\adminTools\WebServices.
To redeploy the web service, do the following:
1. From a Windchill shell, from <Windchill>\bin\adminTools\WebServices, run the following command:
ant -Dservlet.name=WcNonconformanceIfc
-Dwebservice.class=com.ptc.qualitymanagement.nc.jws.WcNonconformanceIfc
deployService -Dsecurity.policy=<security policy to be used>
For example: If the security policy to be used is userNameAuthSymmetricKeys, you would redeploy it using the following command:
ant -Dservlet.name=WcNonconformanceIfc
-Dwebservice.class=com.ptc.qualitymanagement.nc.jws.WcNonconformanceIfc
deployService -Dsecurity.policy=userNameAuthSymmetricKeys
2. In a browser, access the web service at the following URL: http://<host>:<port>/<webapp>/servlet/WcNonconformancelfc?wsdl
<host> is the host name of the Windchill installation, <port> is the port on which the Windchill server is listening, and <webapp> is the web application name provided while installing Windchill.
NCInfo Input Parameters
intent
This specifies if the user wants to create or update the nonconformance.
If the intent is not specified, the default value is create. The values of create and update are not case-sensitive.
locale
Locale of the client.
If not specified, then the session locale is used. If the session locale is not present, then the Windchill server locale is used.
For example: en_US, ja_JP
ncDescription
Description to be used while creating the nonconformance object in Windchill.
ncName
Required to create the nonconformance object in Windchill.
When intent is specified as update, this field is ignored.
ncNumber
Used when specified; otherwise, this is generated based on the object initialization rule set in Windchill.
objectId
Object ID of the nonconformance.
Required when intent is specified as update for the nonconformance object in Windchill.
If the system does not find a nonconformance with the given object ID, an error appears.
qualityContext
Quality context in which the nonconformance needs to be created.
When this value is not provided, the context specified in the ncAttributes.properties file is used.
This file is located in the following location: <Windchill>\codebase\com\ptc\qualitymanagement\nc\jws
requester
Requester to be used when creating a nonconformance object in Windchill. If not specified, then the user making the call is used as the requester.
type
Type of nonconformance object used for creation.
When not specified, a nonconformance object of the Windchill modeled type com.ptc.qualitymanagement.nc.Nonconformance is created. When the specified type does not exist in the Windchill system, an error appears.
The value is the qualified type name in Windchill. For example: WCTYPE|com.ptc.qualitymanagement.nc.Nonconformance|com.org.MyNonConformance or com.org.MyNonConformance
businessFields
List of business fields where each business field is in name or value format.
The name is the logical identifier name of the attribute for the given type.
affectedObjects
List of affected objects for which the nonconformance object needs to be created.
At least one affected object is mandatory during creation. Users can specify more than one affected object during a create or update action. However, during an update action, the user cannot add or delete affected objects, and can only update the nonconforming attributes for the affected parts.
AffectedObject Input Parameters
name
Name of the affected part.
number
Number of the affected part.
version
Version of the affected part.
iteration
Iteration of the affected part.
affectedObjectContainer
Container in which the affected part resides.
objectid
Object ID of the affected part.
The system requires either an objectid or the name, number, version, iteration, and affectedObjectContainer for the part.
quantity
Quantity affected.
This value is used when dispositioning the nonconformance.
unit
Unit type.
Acceptable values are DOZEN, EACH, GROSS, BOX, and KIT.
suppLotBatchNumber
Supplier number (if applicable).
poNumber
Purchase order number (if applicable).
lotControlled
If the item is lot controlled, enter true. If not, enter false.
lotSerialNo
Lot or serial number.
manufacturedQty
Total quantity manufactured.
itemState
State of the item as it relates to the nonconformance.
Acceptable ovalues are POTENTIAL_NC, NONCONFORMING, and WITHIN_SPECS.
manufacturedUnitType
Unit type.
Acceptable values are DOZEN, EACH, GROSS, BOX, and KIT.
manufacturedTo
Date manufacturing ended.
manufacturedFrom
Date manufacturing started.
inputDateFormat
Date format in which the manufacturing start and end date are specified.
For example: yyyy-MM-dd
Was this helpful?