Tech Note 932 - Using The Batch Object Utility
Tech Note 932 - Using The Batch Object Utility
All Tech Notes, Tech Alerts and KBCD documents and software are provided "as is" without warranty of any kind. See the Terms of Use for more information.
Topic#: 002749
Created: February 2013
Introduction
The BatchObjectUtility.exe application is made available through the Wonderware Developer Network to support making some direct
updates to the InBatch Application Objects (InBatchUnit, InBatchConnection, InBatchPhase and InBatchSegment). This utility may be
updated with new functionality as the need arises.
This Tech Note describes the functionality of this utility and the recommended usage scenarios. If the utility is misused, it can potentially
cause problems in the Batch Objects, so users should read and understand the instructions.
Application Versions
Wonderware InBatch 2012 R2 (v. 10)
After connecting to the Galaxy, the remainder of the utility becomes enabled (Figure 1 below).
Of course, it will also update any instances that were created from one of the updated template objects (ex. Unit, Connection, or Phase
instances will inherit changes from their parents).
If Batch Server Name is blank when you do your import, the value Default is used. This value is also used during import to create the
Template Toolset where the InBatch Process/Transfer objects are created.
If you ever change this value in the EnvEdit System Parameters editor after doing an import, you won’t be able to do subsequent imports
to update objects with changes. The import will give warnings because it tries to verify that the BatchServer attribute value matches the
current “Batch Server Name”.
To solve this problem, you could delete the entire set of InBatch Application Objects in your Galaxy and run the import again. However,
that may not always be acceptable; in which case, you can do the following two steps.
1. Rename the Template Toolset to the new Batch Server Name using the ArchestrA IDE (right-click and rename).
2. Use this utility to change the value of the BatchServer attribute on all previously imported InBatch Application Objects.
• Provide the Current and the New BatchServer attribute values. If you leave the Current value blank, it defaults to Default.
3. You can see what the current value is for an object by right-clicking the object, clicking Properties.
The New value should be set to match the Batch Server Name value in EnvEdit System Parameters. The values are all case-
sensitive.
5. After the Current and New values are set, click the Update BatchServer Attribute button.
6. Check the ArchestrA Logger for all objects that are updated.
Important: If the original BatchServer attribute value doesn't match the Current value, the object will not be updated.
When the objects have a BatchServer attribute value that matches the Batch Server Name, you can do subsequent imports to pick up
changes.
D. Tunnell
Tech Notes are published occasionally by Wonderware Technical Support. Publisher: Invensys Systems, Inc., 26561 Rancho Parkway South, Lake Forest, CA 92630. There is also
technical information on our software products at Wonderware Technical Support.
Back to top
©2013 Invensys Systems, Inc. All rights reserved. No part of the material protected by this copyright may be reproduced or utilized in any form or by any means, electronic or
mechanical, including photocopying, recording, broadcasting, or by anyinformation storage and retrieval system, without permission in writing from Invensys Systems, Inc.
Terms of Use.