Update Shell
Description
This method will allow users to update shell instances. User can update more than one shell at a time.
The user will be able to pass in a value for Location Picker element (
Datadefinition : uuu_location) while updating the shell instance.
Location picker value will be validated.
Support
This method only supports update of shells under a company and is not associated with any project.
Installation: ASP and Self host
| Level | Yes or No |
|---|---|
| Company Level | Yes |
| Project/Shell Level | No |
Prototype
public XMLObject updateShell (String shortname, String authcode, String shellType, String shellXML);
Parameters
| Parameter | Description |
|---|---|
| shortname | Identifier of the company, company's short name |
| authcode | Authentication code for the company, in text string |
| shellType | To identify type of the shell that is getting updated, for example, Building, Projects, Capital Projects, Properties, and so on |
| shellXML | This will be based on Shell integration interface definition. Without this definition defined user will not be allowed to update a shell instance |
shellXML Elements
| Tag Name | Required | Description | Valid values |
|---|---|---|---|
| <_shell> | Yes | Base tag for new shell data. This tag can be repeated to create more than one shell instance |
Return Value
See Appendix B: Return Values. Message will contain Shell Number and Shell Name that is updated within Unifier.
Sample Method
updateShell("acme", "acme_authcode", "Buildings","<XML Content>");
Additional Information
Shell that will be updated will be based on shell type and shell number provided as part of XML content.
User will be allowed to update both CBS and Generic shells. For more information about shells, refer to the Unifier uDesigner User Guide.
User will be able to pass in a value for Location Picker element while updating shell instance. Location picker value will be validated.
All other validation while creating shell instance manually will be retained through Integration as follows, required fields, duplicate shell id, and so on.
This method will allow user to update one more shell of same type at a time.