factorytalk® batch material manager - rockwell automation · rockwell automation publication...

User Guide

FactoryTalk® Batch Material Manager

Administrator Guide

FactoryTalk® Batch Material Manager

Important User Information

Solid-state equipment has operational characteristics differing from those of electromechanical equipment. Safety Guidelines for the Application, Installation, and Maintenance of Solid State Controls (publication SGI-1.1 available from your local Rockwell Automation sales office or online at http://www.rockwellautomation.com/literature/) describes some important differences between solid-state equipment and hard-wired electromechanical devices. Because of this difference, and also because of the wide variety of uses for solid-state equipment, all persons responsible for applying this equipment must satisfy themselves that each intended application of this equipment is acceptable.

In no event will Rockwell Automation, Inc. be responsible or liable for indirect or consequential damages resulting from the use or application of this equipment.

The examples and diagrams in this manual are included solely for illustrative purposes. Because of the many variables and requirements associated with any particular installation, Rockwell Automation, Inc. cannot assume responsibility or liability for actual use based on the examples and diagrams.

No patent liability is assumed by Rockwell Automation, Inc. with respect to use of information, circuits, equipment, or software described in this manual.

Reproduction of the contents of this manual, in whole or in part, without written permission of Rockwell Automation, Inc., is prohibited.

Throughout this manual, when necessary, we use notes to make you aware of safety considerations.

WARNING: Identifies information about practices or circumstances that can cause an explosion in a hazardous environment, which may lead to personal injury or death, property damage, or economic loss.

ATTENTION: Identifies information about practices or circumstances that can lead to personal injury or death, property damage, or economic loss. Attentions help you identify a hazard, avoid a hazard, and recognize the consequence

SHOCK HAZARD: Labels may be on or inside the equipment, for example, a drive or motor, to alert people that dangerous voltage may be present.

BURN HAZARD: Labels may be on or inside the equipment, for example, a drive or motor, to alert people that surfaces may reach dangerous temperatures.

Important: Identifies information that is critical for successful application and understanding of the product.

Allen-Bradley, Rockwell Software, and Rockwell Automation ControlLogix, eProcedure, FactoryTalk, RSBizWare, RSBizWare BatchHistorian, RSBizWare Historian, RSBizWare MaterialTrack, and RSLinx are trademarks of Rockwell Automation, Inc.

Trademarks not belonging to Rockwell Automation are property of their respective companies.

http://www.rockwellautomation.com/literature

Rockwell Automation Publication FactoryTalk Batch Material Manager Administrator Guide - February 2017 3

Table of contents

Chapter 1

Identifying the material database ....................................................................................... 5 Setting the Material Server options ................................................................................... 6

Chapter 2

Security settings .................................................................................................................. 11 Material Manager Security ....................................................................................... 12

Using workgroup security ................................................................................................. 13 Using domain security ....................................................................................................... 13

Configuring the domain server ................................................................................ 14 Setting security on folders or files ................................................................................... 14

Adding users and user groups ................................................................................... 15

Chapter 3

Chapter 4

Open the Network Editor ................................................................................................ 19 Network Editor interface ................................................................................................. 20

Hierarchy pane ............................................................................................................ 20 Detail pane ................................................................................................................... 21 Results pane ................................................................................................................. 22 Menu bar ...................................................................................................................... 22 Network Editor toolbar ............................................................................................ 23 Status bar ...................................................................................................................... 23

Configure your network ................................................................................................... 24 Select a network model.............................................................................................. 24 Add a server ................................................................................................................. 25 Remove a server........................................................................................................... 25 Synchronize network models ................................................................................... 26

User Preferences dialog box.............................................................................................. 26 User Preferences dialog box - General tab ............................................................. 27 Edit colors .................................................................................................................... 28 Edit the application font ........................................................................................... 29 Edit information tips ................................................................................................. 30 User Preferences dialog box - Views tab ................................................................. 31 Set report preferences ................................................................................................ 32

Configuring Material Manager

Implementing security

Using the material activity journal

Network Editor

Table of contents

4 Rockwell Automation Publication FactoryTalk Batch Material Manager Administrator Guide - February 2017

Report printing formats .................................................................................................... 33 Preview reports ........................................................................................................... 34 Print reports ................................................................................................................ 35

Chapter 5

Automatic repair of batch component installation fails ............................................. 37 Error: No containers match material container specification ................................... 37 Error: Unable to retrieve the Promise ID ...................................................................... 37 Operating without a Material Server ............................................................................. 38

Losing communication ............................................................................................. 38 Switching to manual .................................................................................................. 41 Restoring communication ........................................................................................ 42 Starting the FactoryTalk Batch server .................................................................... 43

Chapter 6

New user account requirements for the FactoryTalk Batch Server ......................... 45 Configure your FactoryTalk Batch system ................................................................... 46

Server account password change locations ............................................................ 48 Change the server user account for the FactoryTalk Batch Server service...... 49 Change the server user account in FactoryTalk Batch COM+ applications . 50 Change the server user account in My Computer properties ............................ 51

Legal Notices ....................................................................................................................... 53

Troubleshooting

Change the FactoryTalk Batch server user account

Legal Notices Index


Chapter 1

Configuring Material Manager

This chapter contains instructions for configuring FactoryTalk® Batch Material Manager. This chapter assumes that the FactoryTalk Batch system is configured and working properly and that Material Manager is installed.

You must configure the Material Server with the location of the SQL database that contains the materials for the recipes.

1. Click the Start button, point to All Programs > Rockwell Software > FactoryTalk Batch Suite > Material Manager, and then select Network Editor. The Network Editor window opens with the Material Server selected by default.

2. Click the Configure button. The Configure MaterialTrack dialog box opens. The default database is materialbasedrecipe.

Identifying the material database

Chapter 1 Configuring Material Manager


3. In the MaterialTrack Database box, type the name of the database, and then click OK.

Important: The Network Editor does not verify database names. Changes made to the database name are immediate for the clients and servers. If the database name is invalid, the Material Editor will not open. Before changing the database name, check the spelling of the database name and synchronize the Network Editor. After changing the database name, confirm that the Material Editor opens and reads the databases.

4. Click the Synchronize button.

5. From the File menu, select Exit, and then click Yes to exit the Network Editor.

Set the options for the Material Server in the FactoryTalk Batch Equipment Editor module.

1. Click the Start button, point to All Programs > Rockwell Software > FactoryTalk Batch Suite > FactoryTalk Batch, and then select Equipment Editor.

2. From the Options menu, select Server Options. The Server Options dialog box opens to the Project Settings tab.

Setting the Material Server options

Configuring Material Manager Chapter 1


3. Select the Material Polices tab.

• Option when Material Server Comm is lost indicates when communication is lost between the FactoryTalk Batch and Material Servers. You can choose to fail and hold the batch or switch the batch to Manual mode.

• Failure and Hold indicates the FactoryTalk Batch Server places the batch in the HELD state.

• Switch to Manual indicates the FactoryTalk Batch Server continues to run the batch prompting the operator for decisions regarding information normally supplied by the Material Server. (See Troubleshooting for more information.)

• Hold on Split Feed indicates a split feed. Split feeds occur when a material phase step does not add or distribute all of the material configured by the step.

• No directs the FactoryTalk Batch Server to continue processing a batch when a split feed occurs. If you select this option, add a material loop to the recipe so that the binding process can select another container for material additions. (See the FactoryTalk Batch Recipe Editor User Guide for more information on material loops.)

• Yes directs the FactoryTalk Batch Server to hold the batch when a split feed occurs. The Material Server calculates and sends new AMOUNT parameters to the FactoryTalk Batch Server. To resume processing, the operator must perform an active step change away from the unfinished step, manually rebind the unfinished step, perform an active step change back to the unfinished step, and then restart the batch.

4. Make any selections, and then click OK.


Chapter 2

Implementing security

FactoryTalk Batch Material Manager security controls who has permissions for certain actions, such as viewing, adding, removing, and changing an item. Security is set using COM+ role-based security and Windows user groups and users.

Through the use of COM+ role-based security, administration of security for Material Manager is greatly simplified. COM+ role-based security allows an application to have preset user categories called roles. These roles have preset permissions and have preset Windows user groups added to them. To implement security, an administrator must create the preset user groups and add the appropriate user accounts to these groups.

Chapter 2 Implementing security


This flowchart is an example of how security works for Material Manager.

Implementing security Chapter 2


The setup program creates a default user group and preset COM+ roles. Domain user groups and accounts created prior to installation are added to the roles during the installation process. Security is then implemented using Windows user groups and users.

Tip: If you want to customize security, contact Rockwell application support .

Security settings

http://support.rockwellautomation.com/



The local user group installed with Material Manager is MTUsers. This group is assigned permissions to the MaterialBasedRecipe database in SQL Server. The domain user account specified during the installation is added to this group role to allow the Editor to access the database using COM+.

To use domain security, create the following user groups and accounts on the domain prior to installation. These groups and accounts are added to the appropriate COM+ roles during the installation and inherit the permissions of those roles.

• MTBatchServer User Group & COM+ Role Add the FactoryTalk Batch user account under which the FactoryTalk Batch Server service is running to the MTBatchServer group. The MTBatchServer group is added to the MTBatchServer role during installation. This is the role that the FactoryTalk Batch Server uses to access the material database. All FactoryTalk Batch Servers have unlimited access to Material Manager.

• MTGeneral COM+ Role The MTGeneral role is used internally by the Material Server to check security and communication between clients and the server.

• MTLotAuthor User Group & COM+ Role The MTLotAuthor role has permission to add, edit, and delete lots. The MTLotAuthor group is added to the MTLotAuthor role during installation.

• MTMaterialAuthor User Group & COM+ Role The MTMaterialAuthor role has permission to add, edit, and delete materials and containers. The MTMaterialAuthor group is added to the MTMaterialAuthor role during installation.

• MTMaterialViewer User Group & COM+ Role The MTMaterialViewer role has permission to view items in the Editor. The MTMaterialViewer group is added to the MTMaterialViewer role during installation.

Material Manager Security



• Domain user account for the server User The domain user account specified during the installation is added to the local group, MTUsers. This is the account under which the server runs.

Tip: The MaterialServer.log file on the Material Server cannot be viewed from a client computer. You must share the \Program Files\Rockwell Software\Batch folder with the client computers if you want them to be able to reference the logged messages.

When FactoryTalk Batch Material Manager is installed for a workgroup, the local user accounts, local user groups, and COM+ Roles are created and assigned default permissions. You must customize the security settings to meet your facility’s unique requirements as outlined in the following the steps:

Configuring the FactoryTalk Batch Material Manager Workgroup Server and Client Nodes

• You must define Windows user accounts and passwords on all computers that communicate with the Material Server. You need to configure membership in FactoryTalk Batch Material Manager user groups on the Material Server computer only.

Tip: Windows Server 2008 default security does not allow services to run with blank passwords.

• Create Windows User Accounts If you are not using the existing Windows user accounts, create new user accounts with the appropriate rights.

• Add Windows User Accounts to Windows User Groups Add the appropriate Windows user accounts to the FactoryTalk Batch Material Manager user groups on the Material Server computer. The user accounts inherit the rights and permissions of the user group to which they are added.

Perform the following steps to customize the security settings and implement domain security. This is only one possible implementation of domain security; you may find that your specific security requirements involve other steps.

Using workgroup security

Using domain security



Tip: Windows Server 2008 default security does not allow services to run with blank passwords.

• Create Domain User Accounts If you are not using existing user accounts, create domain user accounts that meet your facility’s specific security requirements. For Domain user accounts that need access to Batch client applications, you must add the Windows user accounts to the appropriate FactoryTalk Directory. (See the FactoryTalk Help for more information.)

• Create Domain User Groups Create the following groups on the domain prior to installation of FactoryTalk Batch Material Manager:

• MTBatchServer

• MTLotAuthor

• MTMaterialAuthor

• MTMaterialViewer

• MTGeneral

• Add Domain User Accounts to the Appropriate Domain User Groups Add the appropriate domain user accounts to the domain user groups. The user accounts will inherit the rights and permissions of the user group to which they are added.

You should limit log file and e vent journal (.evt) access to prevent data from being lost. Setting security on the folders or files is one suggested method. Set the security according to your company’s requirements.

Use Notepad to open log files. If a log file is opened with a program other than Notepad, the FactoryTalk Batch Server may not run due to an access error.

Important: FactoryTalk Batch Server continues writing information to log files and event journals (.evt) even when they are open. If a file is opened and then saved, data that may have been written to the event journal or log file while the file is open is lost.

Configuring the domain server

Setting security on folders or files



To add Windows security on folders or files in Windows Explorer complete the following steps.

1. In Windows Explorer, locate the folder or file.

2. Right-click the folder or file, and then select Properties.

3. Select the Security tab, and then click the Add button.

4. From the Select Users, Computers, or Groups dialog box, click Advanced and then click Find Now.

5. Select a User or Group from the Search results: list, and then click OK.

6. Repeat for each User or Group that requires access to the folder or file.

Important: Be sure to add the FactoryTalk Batch Server user account and then configure the account with Full Control permissions.

7. Click OK to return to the Properties dialog box.

8. From the Group or user name: list, select a User or Group, and then select the permissions in the Permissions area. Repeat for each User or Group.

9. Click OK.

Adding users and user groups


Chapter 3

Using the material activity journal

The material activity journal (MaterialBasedRecipe_MAJ) is an SQL database that captures events specific to FactoryTalk Batch Material Manager occurring during a batch run of a material-based recipe. This Material Manager-specific data is stored in the tbActivityJournal table and is found also in the FactoryTalk Batch event journal (.evt) file along with the other non-Material Manager events.

Tip: You must first enable the material logging service. See Enable material journaling in the FactoryTalk Batch Components Upgrade and Installation Guide.

Batch Event Journal Entry

Material Activity Journal Entry

Chapter 3 Using the material activity journal


When the FactoryTalk Batch Server is able to communicate with the Material Server, the Material Manager-specific data is sent to the material activity journal by way of a COM+ queued component that uses features of Microsoft Message Queuing (MSMQ). This queued component enables journaling even when lapses in database communication occur. If the Material Server is not ready to receive data for the material activity journal, this queued component holds the data until the Material Server is ready.

If for some reason the queued component cannot pass the Material Manager-specific data to the material activity journal, the data is stored as messages in a dead queue. If the FactoryTalk Batch Server loses communication with the Material Server, the Material Manager-specific data appears only in the Batch event journal (.evt) file.


Chapter 4

Network Editor

The Network Editor is a utility that allows you to indicate where other FactoryTalk Batch and/or FactoryTalk Batch Material Manager Servers are located on the network. This network configuration information simplifies integration with other FactoryTalk products and the process of reconfiguring a multi-computer system.

During installation, the network configuration information is completed based on your responses. If you have multiple servers in your network, use the Network Editor to update the location of all your servers.

The Network Editor is installed automatically with the FactoryTalk Batch and Material Servers.

See also

Network Editor interface on page 20

Configure your network on page 24

User Preferences dialog box on page 26

Report printing formats on page 33

Open the Network Editor to configure your network.

Tip: If running on Windows Server 2008 or Windows 7, you must run the Network Editor as administrator. Right-click Network Editor and select Run as administrator.

To open the Network Editor:

• Click the Start button, point to All Programs > Rockwell Software > FactoryTalk Batch Suite > FactoryTalk Batch, and then select Network Editor. The Network Editor window opens.

See also

Network Editor on page 19

Open the Network Editor

Chapter 4 Network Editor


The Network Editor interface has the following areas:

• Hierarchy pane

• Detail pane

• Results pane

• Toolbar

• Status bar

See also

Hierarchy pane on page 20

Detail pane on page 21

Results pane on page 22

Network Editor toolbar on page 23

Status bar on page 23

The Hierarchy pane provides a hierarchical view of the application servers in your FactoryTalk Batch system. The Network Model is the parent item in the hierarchy list, with the following application servers listed as Network Model members: Material Server, BatchERP Server, and FactoryTalk Batch Server 1 through Batch Server 10. The following indicators appear next to each server listed:

Indicates the server is recognized on the network

Indicates the server is not defined or recognized

Indicates there is a problem with the server or the server’s configuration

See also


Network Editor interface

Hierarchy pane

Network Editor Chapter 4


The Detail pane provides information specific to the item selected in the Hierarchy pane.

Network Model Information

The following items are available when Network Model is selected in the Hierarchy pane.

Item Description

System Name Allows you to name your FactoryTalk Batch system. The default is Network Model.

Network Model from Displays the name of the computer from which the FactoryTalk Batch system was last synchronized.

Time Stamp Displays the time of the last synchronization.

User Name Displays the Windows user ID of the person who performed the last synchronization.

Apply Changes Saves changes made to the FactoryTalk Batch system information.

Undo Changes Undoes changes made to the FactoryTalk Batch system information that are not applied.

Synchronize All Application Servers Initiates the synchronization of the application servers.

Application Server Information

The following items are available when a server or Undefined is selected in the Hierarchy pane.

Item Description

Alias Displays a user-defined alias for the selected application server.

Computer Name Displays the computer name for the selected server.

Configure Allows you to specify the name of the material database when using FactoryTalk Batch Material Manager. The default database is MaterialBasedRecipe.

Important: The Network Editor does not verify database names. Changes made to the database name are immediate for the clients and servers. If the database name is invalid, the Material Editor will not open. Before changing the database name, check the spelling and synchronize the Network Editor. After changing the database name, confirm that the Material Editor opens and can read the database.

See also


Detail pane



The Results pane provides information messages regarding the results of the last synchronization. Included in the list is an icon indicating the type of message listed, the name of the computer that performed the synchronization, and the message generated by the synchronization process.

The table below shows icons used in the messages and explains what types of messages they represent.

Information Represents an information message.

Error Indicates an error message.

Warning Indicates a warning message.

See also


The menu bar contains the menus for File, Edit, View, and Help.

• File menu

From the File menu, you can select a Network Model, synchronize all servers, print, and exit the Network Editor application.

• Edit menu

From the Edit menu, you can add or remove a server from the Network Editor.

• View menu

From the View menu, you can show or hide the toolbar/status bar, and refresh the Network Editor. You can also specify how data is viewed in the panes as well as setting other user preferences.

See also


Results pane

Menu bar



The Network Editor includes a toolbar which allows you to perform various functions. The buttons are enabled based on the item currently selected in the Network Editor. As you move your cursor over a button, a tool tip displays the button name and a detailed functional description displays in the status bar.

The Network Editor Toolbar buttons are:

Select Network Model: Allows you to select a network model from another computer.

Synchronize: Allows you to synchronize your application servers.

Add Server: Allows you to add a previously undefined server.

Remove Server: Allows you to remove a server.

Up One Level: Moves you up one level in the Hierarchy pane.

Print: Prints a report for the selected item.

Print Preview: Allows you to view a report on the selected item.

Help: Opens the Network Editor help.

See also


The status bar at the bottom of the window displays text messages on the left side. In addition, the status bar displays one or more icons on the right side, representing the status of the application and data.

The list of states that can be displayed in the status bar:

Database: The Network Editor is accessing data.

Server: The Network Editor is accessing other servers.

Printing: A report is being printed or previewed.

Processing: The Network Editor is processing data.

Waiting: The Network Editor is busy.

See also


Network Editor toolbar

Status bar



The Network Editor allows you to configure your FactoryTalk Batch system. You can add or remove application servers, print reports, and synchronize your network model with another computer.

This section provides instructions for performing each of these functions.

See also

Select a network model on page 24

Add a server on page 25

Remove a server on page 25

Synchronize network models on page 26

When you select a network model, you are retrieving an existing network model from another computer and using it as the network model for the local computer. You must do this if you add, remove, or rename a server in your system and need to update your network model with your existing system, or if you want to use the network model from another computer.

To select a network model:

1. Open the Network Editor.

2. In the Network Editor toolbar, click the Select Network Model button.

3. Type the computer name in the Enter the object name to select area, or click the Advanced button to search for a computer.

4. Click OK.

5. Click the Synchronize button.

See also




Configure your network

Select a network model



Use the Network Editor to add a previously undefined server.

To add a server:


2. In the Hierarchy pane, select the type of server to add.

3. Click Add Server.

4. In the Alias box, type an alias name. This is the name that displays in the Network Editor.

5. In the Computer Name box, type the computer name, or use the browse button to locate and select the computer from the list of computers on your domain.

6. Click OK.

See also



Network Editor on page 19


Use the Network Editor to remove a server.

To remove a server:


2. In the Hierarchy pane, select the server to remove.

3. Click the Remove Server button.

See also




Add a server

Remove a server



The synchronization process copies the network model data from your computer to each of the computers included in your FactoryTalk Batch system.

Click the Synchronize button. The Network Editor refreshes and the results of the synchronization process display in the Results pane.

Tip: It is a good idea to synchronize after adding or removing a server from the network model.

See also




The User Preferences function allows you to customize the behavior and appearance of the various panes and views within the Network Editor.

You can turn on information tips, change the application text/background colors, configure the various views, and set up reports used for printing.

See also

Edit colors on page 28

Edit the application font on page 29

Edit information tips on page 30

Set report preferences on page 32

Synchronize network models

User Preferences dialog box



The General tab is used to configure the basic behavior and appearance of the Network Editor views and dialog boxes. The selections on the General tab are used in conjunction with other sections of the User Preferences dialog box.

In the Options area, you have the following selections:

• Use application colors: Select to assign colors, other than the current Windows colors, to the background and text in the views.

• Use application font: Select to change the font, font style, and size from the default Windows style.

• Information tips: Select to enable single line tips that appear when you move the cursor over a button or field.

• Animate dialogs: Select to have dialog boxes fly out from the location from which they are opened.

• Confirm deletion: Select to display an "Are you sure?" message when you delete an item. Leave disabled to delete an item immediately without confirmation.

• Confirm exit: Select to have the application ask if you want to exit. Leave disabled to exit without a confirmation message.

See also


User Preferences dialog box - General tab



The Network Editor defaults to the current Microsoft Windows color scheme. You can change the color of the text and background.

To edit colors:


2. From the View menu, select User Preferences.

3. On the General tab in the User Preferences dialog box, select Use application colors.

4. Select the Colors tab.

5. Disable Use Windows colors to enable the Background color and Text color lists.

6. Select the desired colors from the appropriate list, and then click Apply.

See also



Edit colors



The Network Editor defaults to the current Windows fonts. You can change the display font.

To edit the application font:



3. On the General tab in the User Preferences dialog box, select Use application font.

4. Select the Font tab.

5. Select the desired font, style, and size from the appropriate lists, and then click OK.

6. Click Apply.

7. Click OK.

See also



Edit the application font



Information tips appear when you move the cursor over a button or field. You can change the font and colors of tips, and set tip timing, which determines how soon a tip displays.

To edit information tips:



3. On the General tab in the User Preferences dialog box, select Information tips.

4. Select the Tips tab.

5. To enable the Background color and Text color lists, disable Use Windows colors.

6. To change the tip color, select the text and background colors from the appropriate lists, and then click OK.

7. To change the tip font, click the Change Font button. The Font dialog box opens. Select the desired font, style, and size from the appropriate list, and then click OK.

8. To change the timing of information tips, use the Up and Down arrows to change the settings in the Timing area.

• Delay determines how soon a tip displays when the cursor stops on an area with a tip.

• Visible duration determines how long the tip is visible before closing.

9. Click Apply.

10. Click OK.

See also



Edit information tips



If you want to configure properties that are specific to each view and list in the Network Editor, use the Views tab. For all list views, you can enable information tips, alter the behavior of drag and drop, change the appearance of scroll bars, and set selection options. On selected views, you can change the font style and color, as well as the background color.

See also



User Preferences dialog box - Views tab



You can define a footer to print on each report page and select the font and color (if your printer supports color printing) for the various report sections.

To set report preferences:

1. From the View menu, select User Preferences. The User Preferences dialog box opens to the General tab.

2. Select the Reports tab. The default report style for most views is Formatted.

3. To change the type of printed report, select either List or Formatted to the right of the appropriate report.

Tip: If you select the List format, set the page orientation to landscape. From the File menu, select Print Setup, select Landscape in the Orientation area, and then click OK.

4. Where available, you can select Include Related Data, and any additional data associated with the selected item (single items only – not lists or groups) also prints on the report.

5. In the Footer Text box, type a word or phrase to appear centered at the bottom of each page.

6. Click Apply.

See also



Set report preferences



The Network Editor report printing feature allows you to print network, server, or result pane information, in a report formatted with headers, footers and column headings (in list reports). There are two report formats available: formatted and list. The header (at the top of the page) consists of the report name, while the footer (at the bottom of the page) contains the printing date/time and the page count.

A formatted report presents the information down the page, with bold field names as shown in this figure.

A list report presents the data in a columnar, spreadsheet format, with one line per data item. The field names become column headings as shown in this figure.

You can customize the reports by setting margins, changing font styles, and selecting text colors. In addition, you can enter custom text that is also included in the footer. (See Set report preferences for more information.)

See also


Report printing formats



The Print Preview function of the Network Editor allows you to see how a printed report looks before you send it to the printer.

To preview reports:

1. Click the Print Preview button. The Print Preview window opens, displaying the report as it will look when printed. The following options are available from the Print Preview window:

• Next Page – If there is more than one page in the report, click Next Page to view the next page of the report.

• Prev Page – Click to view the previous report pages (if there is more than one page in the report).

• Two Page – Allows you to view two pages of a report in the same window.

• One Page – Returns to the default preview setting of one page per window.

• Zoom In/Out – Click Zoom In to magnify the preview page. Click Zoom Out to reduce the size of the page in the preview window.

• Close – Closes the preview window.

2. Click Close to return to the Network Editor. You can either print the report or make additional report configuration changes.

See also


Print reports on page 35


Preview reports



The Network Editor report printing feature allows you to print network, server, or result pane information, in a report formatted with headers, footers and column headings (in list reports).

To print reports:

1. In the Network Editor’s Hierarchy pane, select the list or item(s) that you want to print.

2. From the File menu, click Print. You could also click the Print button or press CTRL+P to display the Print dialog box.

3. Ensure that the correct printer is selected, and click OK.

Tip: To configure heading and footer fonts and add a custom footer to your reports, see Set report preferences for instructions.

See also


Preview reports on page 34


Print reports


Chapter 5

Troubleshooting

This chapter contains information specific to troubleshooting the FactoryTalk® Batch Material Server. (See the FactoryTalk Batch Administrator Guide for information on troubleshooting the FactoryTalk Batch Server.)

This can happen if one or more necessary folders were unintentionally moved (in Windows explorer). For example, if the Schema folder gets moved away from its original install path, the install package starts up automatically and tries to ‘repair’ the problem. This ‘repair’ can clear out the Model and Server keys in the registry, which can make the Batch client editors generate warning dialogs because they are not able to find the Network Model.

If this happens, completely uninstall the application and then reinstall it.

This error can appear for several reasons. Here are a few things to check when this message appears:

• The container’s state is not marked Ready to Use.

• The lot state of the sublot in the container is not marked Ready to Use.

• The material specification of the step does not match the material specification of a sublot.

If Material Manager offers the equipment ID of container to a recipe (A) and that container already has a Promise ID issued to another recipe (B), the recipe (A) trying to use that container goes into Hold. The operator receives the error: "Unable to retrieve the Promise ID". This prevents the inadvertent dumping of two materials into the same empty container, thus (possibly) destroying both materials.

Automatic repair of batch component installation fails

Error: No containers match material container specification

Error: Unable to retrieve the Promise ID

Chapter 5 Troubleshooting


There may be a time when communication between the FactoryTalk Batch Server and the Material Server is lost. If this occurs during a batch run, the operator can complete the batch without the Material Server.

Tip: To run material-based recipes without the Material Server, use the upper range request codes (11000-18000) in the phase logic. (See Unable to Communicate with Material Server in the PCD Programmer Technical Reference Guide for more information.)

Because the Material Server cannot provide the FactoryTalk Batch Server with information necessary for automatic binding, the operator is prompted to select the containers/equipment modules for binding. Also, since the Material Server populates the material database with material additions and distributions, this task must be performed manually when the batch is complete.

If the FactoryTalk Batch Server is configured to Switch to Manual and communication is lost with the Material Server, the FactoryTalk Batch Server switches to prompt binding and presents an unfiltered list of container/equipment module pairs from which to select binding candidates. The operator must select the container/equipment module pair to supply the correct material to continue processing the batch. Failure to select the correct container/equipment module pair could result in a hazardous situation depending on the material.

When communication is good between the FactoryTalk Batch and Material Servers, the Failed Material Server Indicator in the FactoryTalk Batch View status bar displays a green MT-G.

When the FactoryTalk Batch Server loses communication with the Material Server, The Failed Material Server Indicator in the FactoryTalk Batch View status bar displays a red MT-B.

If the FactoryTalk Batch Server is configured to Failure and Hold when communication is lost with the Material Server, the batch is held until communication resumes and the operator clears the failure.

Operating without a Material Server

Losing communication

Troubleshooting Chapter 5


If the FactoryTalk Batch Server is configured to Switch to Manual when communication is lost with the Material Server, the batch continues to run and the following occurs:

• All binding switches to prompt binding. Because the FactoryTalk Batch Server cannot access the information in the material database, the lists of equipment modules and containers are generated from the area model. Any other information provided by the material database, such as capacity, engineering unit, lot, and label, does not display. The operator must select the equipment module and container that can add material to or distribute material from the batch.

• The FactoryTalk Batch Server begins to use a default invalid promise ID since the Material Server cannot send a valid promise ID, which is used to update the inventory in the Material Editor. The actual amounts added or distributed in the recipe must be manually updated in the material database. In split feed situations, the FactoryTalk Batch Server continues to update the setpoint so processing can continue.



• The FactoryTalk Batch Server records Loss of Material Tracking and Loss of Material Server in the event journal. When the batch is complete, the additions and distributions must updated manually into the material database.

(See the FactoryTalk Batch View User Guide for information on the status bar and event journal. See the FactoryTalk Material Editor User Guide for information on updating the material database manually.)

Possible Failure and Hold Errors

When using a Failure and Hold configuration, and a break in communication happens after the Promise ID is required and the reporting is the first communication that fails, the Promise ID given by the Material Server may still exist in the material database. These "orphaned" Promise IDs can be a problem for several reasons.

1. A distribution type promise is limited to 1 per container. An orphaned promise of this type locks the container to other distributions.

2. Over-consumption also can be affected by this — The FactoryTalk Batch Server may assume there are active addition promises when in actuality this promise is no longer attached to a running phase.

Reporting only happens once the phase transitions to a STOPPED, ABORTED or COMPLETED state.

To solve this problem, open the event journal and look for the event description "Material Distribution Database Reporting Failed - Event Type Material Tracking." Go to the tbPromise table and delete the Promise ID record that was noted in the event journal entry.



Upon installation, the FactoryTalk Batch Server is configured to fail and hold a batch when communication with the Material Server is lost. If you want to run batches even when communication is lost, configure the FactoryTalk Batch Server to switch to Manual mode. In Manual mode, the FactoryTalk Batch Server prompts the operator for information normally supplied by the Material Server.

1. Click the Start button, point to All Programs > Rockwell Software > FactoryTalk Batch Suite > FactoryTalk Batch, and then select Equipment Editor.

2. From the Options menu, select Server Options. The Server Options dialog box opens to the Project Settings tab.

3. Select the Material Policies tab.

4. Select Switch to Manual, and then click OK.

Tip: If you are using the FactoryTalk Event Archiver, select the Archiver Event Filters tab while you are in the Server Options dialog box to verify that Loss of Material Server and Loss of Material Tracking are enabled.

5. Exit the FactoryTalk Batch Equipment Editor.

Switching to manual



When communication between the FactoryTalk Batch and Material Servers becomes available, the action of the FactoryTalk Batch Server depends on the setting selected on the Material Policies tab of the Server Options dialog box in the Equipment Editor.

• If the FactoryTalk Batch Server is configured to Failure and Hold, the Failed Material Server Indicator in the FactoryTalk Batch View status bar displays a green MT-G when the Material Server becomes available. The operator must clear the failure for the batch to continue processing. (See the FactoryTalk Batch View User Guide for more information.)

• If the FactoryTalk Batch Server is configured to Switch to Manual, the Failed Material Server Indicator in the FactoryTalk Batch View status bar displays a yellow MT-S when the Material Server becomes available. The operator must restore communication manually when appropriate.

Tip: If you want to limit security on the Failed Material Server Indicator dialog box, disable the Material Server Control button for specified users or groups. (See Configure FactoryTalk Batch View Security in the FactoryTalk Batch Administrator Guide.)

1. Double-click the Failed Material Indicator in the FactoryTalk Batch View. The Failed Material Server Indicator dialog box opens.

2. Click the Material Server Control button. The Material Server Control dialog box opens.

3. Select Reestablish Communication with Material Server, and then click OK.

Important: Be aware that the material database is not synchronized with the FactoryTalk Batch Server and the data in the material database must be updated manually. (See the FactoryTalk Material Editor User Guide for information on updating the material database manually.)

Restoring communication



A cold boot requires communication between the FactoryTalk Batch and Material Servers. If the Material Server is unavailable, the FactoryTalk Batch Server will not start. During a cold boot, the container, material, and material class enumerations are created based on the information in the material database. Once this information becomes resident in the FactoryTalk Batch Server, it can process a batch without the Material Server.

This material data (container, material, and material class enumerations) resident in the FactoryTalk Batch Server is referred to as persisted data. A cold boot refreshes this data by downloading new data from the material database via the Material Server. A warm or warm-all boot does not refresh this data.

If you need to restart the FactoryTalk Batch Server when the Material Server is unavailable, use either the warm or warm-all boot method. Both of these methods ensure that the container, material, and material class enumerations resident in the FactoryTalk Batch Server prior to the restart are restored.

(See the FactoryTalk Batch Administrator Guide for more information on the FactoryTalk Batch Service Manager.)

Starting the FactoryTalk Batch server


Chapter 6

Change the FactoryTalk Batch server user account

Depending on your facility’s security requirements you may need to change the FactoryTalk Batch server user name and password periodically. If you change the server’s user account after installing the FactoryTalk Batch components you must configure your FactoryTalk Batch system to use the new server user account.

Tip: The user account for the FactoryTalk Batch server, Batch Archiver, eProcedure server services and the Batch COM+ Application must be identical.

See also

New user account requirements for the FactoryTalk Batch server on page 45

When creating a new user account for the FactoryTalk Batch Server, the following requirements must be met.

• The password must be configured never to expire--if the password ever expires, the service eventually fails to log on.

• The user account must never be disabled or deleted--if this account is ever disabled/deleted, the service eventually fails to log on.

• The domain user account must have a unique name--if the user account is a domain account, remove any local user accounts with the same name.

• The user account/user group must exist on all workgroup computers--if you want a local account to have access to resources on other computers in a workgroup environment, you must create accounts with the same name and password on each computer in the workgroup.

New user account requirements for the FactoryTalk Batch Server

Chapter 6 Change the FactoryTalk Batch server user account


After you create a new user account for the FactoryTalk Batch Server, configure your FactoryTalk Batch system.

To configure your FactoryTalk Batch system:

1. Configure the FactoryTalk Batch Server computer:

a. Add the new server user account to the batchsvr_group and administrators group. By adding the new account to the batchsvr_group it inherits all the required user rights and access permissions.

b. If FactoryTalk Batch Material Manager is part of your system, add the new FactoryTalk Batch Server user account to the MTBatchServer group on the Material Server computer.

c. Add the new FactoryTalk Batch Server user account to the FactoryTalk Batch Server service.

d. If you are running FactoryTalk Event Archiver in incremental mode, add the new FactoryTalk Batch Server user account in the Batch Archiver service.

e. If FactoryTalk eProcedure is part of your system, add the new FactoryTalk Batch Server user account to the eProcedure Server service.

f. Add the new FactoryTalk Batch Server user account to the Batch COM object in Component Services > My Computer > COM+ Applications.

Configure your FactoryTalk Batch system

Change the FactoryTalk Batch server user account Chapter 6


2. Configure the FactoryTalk Batch Client computer(s):

a. If you are using workgroup security, create the new FactoryTalk Batch Server user account on all FactoryTalk Batch Client computers in the workgroup.

b. Add the new FactoryTalk Batch Server user account to Component Services > My Computer > Properties > COM Security on all remote FactoryTalk Batch View computers. Configure the account with Access Permissions: Local Access and Remote Access.

c. If eProcedure is part of your system, add the new FactoryTalk Batch Server user account to Component Services > My Computer > Properties > COM Security on all remote eProcedure Client computers. Configure the account with Access Permissions: Local Access and Remote Access.

See also

Server account password change locations on page 48

Change the server user account for the FactoryTalk Batch Server service on page 49

Change the server user account in FactoryTalk Batch COM+ applications on page 50

Change the server user account in My Computer properties on page 51



If you change the password for the existing FactoryTalk Batch Server user account, change the password in these locations:

• If you are using Workgroup security, change the password for the FactoryTalk Batch Server user account on all FactoryTalk Batch computers in the workgroup.

• Change the password for the FactoryTalk Batch Server user account in the FactoryTalk Batch server service.

• If you are running FactoryTalk Event Archiver in incremental mode, change the password for the FactoryTalk Batch Server user account to the Batch Archiver service.

• If eProcedure is part of your system, change the password for the FactoryTalk Batch Server user account in the eProcedure Server service.

• Change the password for the FactoryTalk Batch Server account in the Batch COM object in Component Services > My Computer > COM+ Applications.

See also

Configure your FactoryTalk Batch system on page 46

Server account password change locations



To change the user account for the FactoryTalk Batch Server service, complete these steps on the server computer.

To change the server user account for the FactoryTalk Batch Server service:

1. Point to Administrative Tools > Services, and then click Services. The Services dialog box opens.

2. Right-click Batch Server, and then click Properties. The FactoryTalk Batch Server Properties dialog box opens.

3. On the Log On tab, select This Account and type the new user and/or password.

4. Click OK.

• If you are using FactoryTalk Event Archiver in incremental mode, change the user account name and/or password for the Batch Archiver service.

• If eProcedure is part of your system, change the user account name and/or password for the eProcedure Server service.

5. Close Services.

See also

Configure your FactoryTalk Batch system on page 46

Change the server user account for the FactoryTalk Batch Server service



To change the FactoryTalk Batch Server user account in Batch COM+ applications, complete these steps on the FactoryTalk Batch Server computer.

To change the server user account in FactoryTalk Batch COM+ applications:

1. Point to Administrative Tools > Component Services.

2. Expand Component Services, Computers, My Computer and COM+ Applications.

3. Right-click Batch, and then select Properties. The Batch Properties dialog box opens.

4. On the Identity tab, select This user and type the new FactoryTalk Batch Server user name and/or password.

5. Click OK.

Tip: The new permissions are applied the next time the FactoryTalk Batch Server is started on the computer.

See also


Change the server user account in FactoryTalk Batch COM+ applications



To change the FactoryTalk Batch Server user account in My Computer properties, complete these steps on the FactoryTalk Batch Client computers.

To change the server user account in My Computer properties:

1. Point to Administrative Tools > Component Services.

2. Expand Component Services and Computers.

3. Right-click My Computer, and then click Properties. The My Computer Properties dialog box opens.

4. On the COM Security tab, click the Edit Default button in the Access Permissions area. The Access Permission dialog box opens.

5. Click the Add button to open the Select Users, Computers, or Groups dialog box.

6. Type the new FactoryTalk Batch Server user account name and then click OK.

7. In the Access Permission dialog box, select the new FactoryTalk Batch Server account. In the Permissions list, select Allow for Local Access and Remote Access.

8. Click OK twice.

9. Close Component Services.

10. Restart the computer.

See also


Change the server user account in My Computer properties


Legal Notices

Copyright notice

© 2017 Rockwell Automation Technologies, Inc. All rights reserved. Printed in USA.

This document and any accompanying Rockwell Software products are copyrighted by Rockwell Automation Technologies, Inc. Any reproduction and/or distribution without prior written consent from Rockwell Automation Technologies, Inc. is strictly prohibited. Please refer to the license agreement for details.

End User License Agreement (EULA)

You can view the Rockwell Automation End-User License Agreement ("EULA") by opening the License.rtf file located in your product's install folder on your hard drive.

Trademark Notices

Allen-Bradley, CompactLogix, ControlLogix, Connected Components Workbench, eProcedure, FactoryTalk, GuardLogix, GuardPLC, Micro800, MicroLogix, MobileView, MobileView Guard, PanelBuilder, PanelView, PhaseManager, PlantLink, PlantPAx, PLC-2, PLC-3, PLC-5, PowerMonitor, RSBizWare, RSBizWare BatchHistorian, RSBizWare Historian, RSBizWare MaterialTrack, RSLinx, Rockwell Automation, Rockwell Software, SLC, SoftLogix, Studio 5000, and XMare trademarks of Rockwell Automation, Inc.

Any Rockwell Automation software or hardware not mentioned here is also a trademark, registered or otherwise, of Rockwell Automation, Inc.

For a complete list of products and their respective trademarks, go to: http://www.rockwellautomation.com/rockwellautomation/legal-notices/overview.page?#tab4

Legal Notices

http://www.rockwellautomation.com/rockwellautomation/legal-notices/overview.page?%23tab4


Legal Notices


Warranty

This product is warranted in accordance with the product license. The product’s performance may be affected by system configuration, the application being performed, operator control, maintenance, and other related factors. Rockwell Automation is not responsible for these intervening factors. The instructions in this document do not cover all the details or variations in the equipment, procedure, or process described, nor do they provide directions for meeting every possible contingency during installation, operation, or maintenance. This product’s implementation may vary among users.

This document is current as of the time of release of the product; however, the accompanying software may have changed since the release. Rockwell Automation, Inc. reserves the right to change any information contained in this document or the software at any time without prior notice. It is your responsibility to obtain the most current information available from Rockwell when installing or using this product.

Environmental compliance

Rockwell Automation maintains current product environmental information on its website at http://www.rockwellautomation.com/rockwellautomation/about-us/sustainability-ethics/product-environmental-compliance.page

Contact Rockwell Automation

Customer Support Telephone — 1.440.646.3434

Online Support — http://www.rockwellautomation.com/support/

http://www.rockwellautomation.com/rockwellautomation/about-us/sustainability-ethics/product-environmental-compliance.page


http://www.rockwellautomation.com/support/


A Archiver

service 46

B Batch Server

starting 43 switching to manual mode 41

boot cold 43 warm 43 warm-all 43

C change

colors 28, 31 fonts 31 list view properties 31 report margins 32 view properties 31

cold boot 43 colors

change 28, 31 COM+ 9 communication

configuring Material Server 6 restoring with Material Server 42 without Material Server 38

configure formatted reports 33 list reports 33 Network Editor 5 report footings 32 report headings 32 user preferences 26 workgroup server nodes 13

D database

changing names 5 disable

Material Server Control button 42

domain security 13

F Failed Material Server Indicator 38 failure and hold 38 failure and hold errors 38 formatted report 33

L list report 33 list view properties

change 31

M manual mode

switching the Batch Server 41 material database

changing names 5 configuring Network Editor 5

Material Server configuring communication mode 6 configuring split feeds 6 losing communication 38 restoring communication 42

Material Server Control button disabling 42

MT-B 38 MTBatchServer 12 MT-G 38, 42 MTGeneral 12 MTLotAuthor 12 MTMaterialAuthor 12 MTMaterialViewer 12 MT-S 42 MTUsers 12

N Network Editor

configuring material database 5 network model

synchronize 24

Index

Index


O orphaned promise ID 38

P print preview 34 promise ID

orphaned 38 prompt binding, losing communication 38

R report preferences

set 32 reports

change margins 32 column and row preferences 32 configure footings 32 configure headings 32

S security

Batch Server 12 domain 13

user accounts 14 user groups 14

role-based 9 roles

MTBatchServer 12 MTGeneral 12 MTLotAuthor 12 MTMaterialAuthor 12 MTMaterialViewer 12 MTUsers 12

user groups MTBatchServer 12 MTLotAuthor 12 MTMaterialAuthor 12 MTMaterialViewer 12

workgroup 13 set

report preferences 32 user preferences 26

split feed configuring Material Server 6

starting Batch Server 43

synchronize 24

T troubleshoot

failure and hold errors 38

U User Preference dialog box

change colors 28, 31 change fonts 31 change view properties 31 column and row preferences 32 edit information tips 30 list view properties 31 set 26

V view properties 31

W warm boot 43 warm-all boot 43 workgroup

configuring server nodes 13 security 13

User Guide

FactoryTalk® Batch Material Editor

Rockwell Automation Publication FactoryTalk Batch Material Editor User Guide - February 2017 3

Table of contents

Chapter 1

The Editor interface ............................................................................................................. 7 Menu bar ......................................................................................................................... 8 Toolbars .......................................................................................................................... 9 Hierarchy pane ............................................................................................................ 10 Detail pane ................................................................................................................... 10

List view ................................................................................................................ 11 Status bar ...................................................................................................................... 12

Chapter 2

Setting user preferences ..................................................................................................... 13 Setting general preferences ....................................................................................... 14 Changing colors .......................................................................................................... 15 Changing fonts ........................................................................................................... 16 Editing information tips ........................................................................................... 17 Changing view properties ......................................................................................... 18

Changing list view properties ........................................................................... 18 Changing view fonts .......................................................................................... 19 Changing view colors ......................................................................................... 19 Working with columns and rows .................................................................... 20

Configuring the materials list .................................................................................. 20 Enabling material name filtering ..................................................................... 21

Configuring the material display ............................................................................. 22 Selecting another Material Server ................................................................................... 23 Generating printed reports ............................................................................................... 24

Previewing reports ...................................................................................................... 24 Printing reports ........................................................................................................... 25 Setting report preferences ......................................................................................... 26

Changing margins .............................................................................................. 28 Setting the report fonts and colors .................................................................. 29

Chapter 3

Creating new states ............................................................................................................ 34 Editing states ....................................................................................................................... 35 Deleting states ..................................................................................................................... 35

Using the Material Editor

Configuring the Material Editor

Configuring states

Table of contents

4 Rockwell Automation Publication FactoryTalk Batch Material Editor User Guide - February 2017

Chapter 4

Creating material types ..................................................................................................... 38 Editing material types ................................................................................................ 39 Delete material types.................................................................................................. 39

Chapter 5

Creating material classes ................................................................................................... 42 Editing material classes ...................................................................................................... 44 Edit material class properties ........................................................................................... 45

Using a form to edit material class properties ....................................................... 46 Deleting material classes ................................................................................................... 46 Deleting material class properties ................................................................................... 47

Chapter 6

Creating a material record ................................................................................................ 49 Configuring material properties ...................................................................................... 52

Adding material properties ....................................................................................... 52 Editing material properties ....................................................................................... 54 Using a form to edit material properties ................................................................ 55 Deleting material properties ..................................................................................... 55

Configuring material lots.................................................................................................. 56 Adding new lots .......................................................................................................... 56 Deleting lots ................................................................................................................ 57 Editing a lot ................................................................................................................. 57

Using a form to change lot properties ............................................................ 58 Distributing a lot ........................................................................................................ 59 Changing a sublot quantity ...................................................................................... 60 Deleting a sublot ......................................................................................................... 60

Configuring containers ..................................................................................................... 61 Assigning containers to materials ............................................................................ 61 Removing a container ................................................................................................ 62

Configuring material priorities........................................................................................ 63 Configure material inventory .......................................................................................... 64

Changing a sublot quantity ...................................................................................... 64 Deleting a sublot ......................................................................................................... 65 Managing inventory distribution ............................................................................ 66

Deleting materials .............................................................................................................. 66

Configuring material types

Configuring material classes

Configuring materials

Table of contents


Chapter 7

Configuring storage containers ....................................................................................... 68 Creating a storage container..................................................................................... 69 Configuring container properties ........................................................................... 70

Editing container properties ............................................................................ 71 Deleting container properties .......................................................................... 71

Configuring container materials ............................................................................. 72 Removing a material .................................................................................................. 73 Configuring container priorities ............................................................................. 74 Configuring container inventory ............................................................................ 75 Changing inventory quantity ................................................................................... 75 Deleting a distribution .............................................................................................. 75 Distributing a lot ........................................................................................................ 76 Adding a new quantity of material to a deleted sublot ....................................... 77

Editing storage containers ................................................................................................ 77 Deleting storage containers .............................................................................................. 78 Creating storage locations ................................................................................................ 78 Editing storage locations ................................................................................................... 79 Deleting storage locations ................................................................................................. 80

Chapter 8

Accessing the heel property from phase logic ............................................................... 83 Material object model support for heel property ......................................................... 83 Legal Notices ....................................................................................................................... 85

Configuring storage containers and locations

Using container heel properties

Legal Notices

Index


Chapter 1

Using the Material Editor

This information provides quick and easy access to information and procedural instructions required to configure materials and the containers to hold them. The material data is stored in the material database, which is used to create material-based recipes. This information is intended as a reference for the formulator.

The Editor interface is similar to Windows Explorer in the way items are displayed and the way you navigate within the application. The Editor has five standard areas: menu bar, toolbar, hierarchy pane, detail pane, and status bar.

The Editor interface

Chapter 1 Using the Material Editor


The menu bar is similar to the standard menu bar found on most Windows applications. The menu bar contains the pull-down menus for File, Edit, View, Tools, and Help.

The following table describes the menu bar commands:

Item Definition

File Provides options for creating new objects, printing objects, and exiting the Editor.

Edit Provides options for deleting selected items and viewing item properties. You use the Properties option for editing various items.

View Allows you to show or hide the toolbar and status bar. You can also specify how data is viewed in the Detail pane and set user preferences for the Editor.

Tools Allows you to configure system properties.

Help Provides you with on-line help and information regarding the software and the system.

Menu bar

Using the Material Editor Chapter 1


The Editor has toolbars that are mode-specific, meaning the available icons on the toolbar change depending on the current mode of the Editor. The following table describes the options available on the various toolbars.

Icon Description Mode/View

Create new item of the type of item currently selected All

Print preview All

Cut selected item All

Copy selected item All

Paste selected item All

View properties of the selected item All

Go to the folder one level up All

Invoke online help for the Editor All

Display items by using large icons All

Display items by using small icons All

Display items in list format All

Display detailed information for each item in the list view All

Toolbars



The left pane, called the Hierarchy pane, always contains a hierarchical (tree) view of the Editor data — much like the list of folders and files shown in Windows Explorer. The Hierarchy pane is a visual representation used to navigate through the data. The hierarchical tree view is the principal mechanism for accessing the application data and controlling how the data is viewed in the Detail pane.

• Material Configuration List contains a list of available materials.

• Material Storage Configuration List contains a list of storage containers and locations that are used for storing the various materials.

The right pane, called the Detail pane, always contains a view that represents one or more data items in the Hierarchy pane. This view is used to display the data in more detail. The detail pane is the principal mechanism for viewing the application data in detail. It is generally a list view, but may also be an editable table view, a form view, or a graphical view.

• Material Configuration

• Material Storage Configuration

• Materials

• Locations

• Independent Containers

Hierarchy pane

Detail pane

Using the Material Editor Chapter 1


The List View mode of the Detail pane contains data items in a columnar or icon format, depending on the mode and selected item. There are four ways to display the data items in the List View (the associated toolbar button is seen to the left of each description):

Large icons

Each item appears as a full-sized icon (32 x 32 pixels) with a label below it. You can drag the items to any location in the List View.

Small icons

Each item appears as a small icon (16 x 16 pixels) with the label to the right of it. You can drag the items to any location in the List View.

List Each item appears as a small icon with a label to the right of it. Items are arranged in columns and cannot be dragged to any location in the List View.

Details Each item appears on its own line, with additional information arranged in columns to the right. The leftmost column contains the small icon and label, and subsequent columns contain subitems as specified by the Editor.

With the exception of the first column of data in the List View, you cannot directly edit the data items. You can edit the data in the first column directly or right-click the desired item and select Rename.

List view



The status bar at the bottom of the Editor window usually displays a text message or state on the left side and the standard Caps Lock, Scroll Lock, and Num Lock states on the right side. In addition, to the immediate left of the Num Lock state, the status bar may display one or more icons representing the state and status of the Editor and/or its data. The following is a list of states that may be displayed in the status bar:

Database The Editor is accessing data.

Error An error occurred when editing data.

Information The currently selected data is predefined and not editable.

Warning A message displays a warning.

Critical A message displays critical error information.

Question A message displays a question.

Searching The Editor is searching for data.

Secured The currently selected data is secured.

Printing A report is being printed or previewed.

Processing The Editor is processing data.

Waiting The Editor is busy.

Verification Data is being verified.

Status bar


Chapter 2

Configuring the Material Editor

There re several settings you can choose from to configure the Material Editor. You can turn on information tips, change the text and background colors of the application, configure the various views, and set up reports used for printing recipe data. You can also change the location of the Material Server.

The User Preferences function allows you to customize the behavior and appearance of the various panes and views within the Editor application.

Setting user preferences

Chapter 2 Configuring the Material Editor



The General tab is used to configure the basic behavior and appearance of the Material Editor views and dialog boxes. The selections on the General tab are used in conjunction with other sections of the User Preferences dialog box.

In the Options area you have the following selections:

• Use application colors: Select to assign colors, other than the current Windows colors, to the background and text in the views. (See Changing colors for more information.)

• Use application font: Select to change the font, font style, and size from the default Windows style. (See Changing fonts for more information.)

• Information tips: Select to enable single line tips that appear when you move the cursor over a button or field. (See Editing information tips for more information.)

• Animate dialogs: Select to have dialog boxes fly out from the location from which they are opened.

• Confirm deletion: Select to display an "Are you sure?" message when you delete an item. Leave disabled to delete an item immediately without confirmation.

• Confirm exit: Select to have the application ask if you want to exit. Leave disabled to exit without a confirmation message.

2. Make the desired selection, and then click Apply.

Setting general preferences

Configuring the Material Editor Chapter 2


The Material Editor defaults to the current Windows color scheme. You can change the color of the text and background.

1. On the General tab in the User Preferences dialog box, select Use application colors.

2. Select the Colors tab.

3. Disable Use Windows colors to enable the Background color and Text color lists.

4. Select the desired colors from the appropriate list, and then click Apply.

Changing colors



The Material Editor defaults to the current Windows fonts. You can change the display font.

1. On the General tab in the User Preferences dialog box, select Use application font.

2. Select the Font tab.

3. Click the Select Font button. The Font dialog box opens.

4. Select the desired font, style, and size from the appropriate lists, and then click Apply.

Changing fonts



Information tips appear when you move the cursor over a button or field. You can change the font and colors of tips, and set tip timing, which determines how soon a tip displays.

1. On the General tab of the User Preferences dialog box, select Information tips to enable tips.

2. Select the Tips tab.

3. To enable the Background color and Text color lists, disable Use Windows colors.

4. To change the tip color, select the text and background colors from the appropriate lists, and then click OK.

5. To change the tip font, click the Change Font button. The Font dialog box opens. Select the desired font, style, and size from the appropriate list, and then click OK.

6. To change the timing of information tips, use the Up and Down arrows to change the settings in the Timing area.

• Delay determines how soon a tip displays when the cursor stops on an area with a tip.

• Visible duration determines how long the tip stays visible before closing.

7. Click Apply.

Editing information tips



If you want to configure properties specific to each view and list in the Editor, use the Views tab. For all list views, you can enable information tips, alter the behavior of drag and drop, change the appearance of scroll bars, and set selection options. On selected views, you can change the font style and color, as well as the background color.

The List View Properties area contains the following options to change the appearance and behavior of items seen in a list view.

• "Hot" list selection – If selected, an item is automatically highlighted and selected when the cursor remains over the item for a certain period of time.

• List information tips – If selected, single-line tips appear when you move the cursor over a button or field. (See Editing information tips for more information.)

• Flat scroll bars – If selected, scroll bars appear 2-dimensional. If disabled, scroll bars have a 3-dimensional appearance (Windows default). The following figure illustrates both the default (on the left) and flat (on the right) scroll bars:

• Header drag and drop – If selected, users can click and drag a header from one location to another in order to rearrange the columns.

• Header "hot" tracking – If selected, an item is automatically highlighted but not selected when the cursor moves over a header item. You must still click the item at least once to activate it.

• Subitem images – Not currently enabled.

Changing view properties

Changing list view properties



You can change the font, font style, or font size for a selected view.

1. Select the Views tab on the User Preferences dialog box.

2. In the General View Properties area, select a view, and then click the Edit View Properties button. The View Properties dialog box opens to the Colors tab.

3. Select the Font tab, and then click the Change Font button. The Font dialog box opens.

4. Select the desired font, style, and size, and then click OK. The View Properties dialog box displays the selections you made.

5. Click OK to return to the User Preferences dialog box.

6. Click Apply.

1. You can change the colors used in a selected view.

2. Select the Views tab on the User Preferences dialog box.

3. In the General View Properties area, select a view, and then click the Edit View Properties button. The View Properties dialog box opens to the Colors tab.

4. To enable the Window Background, Text Background, and Text lists, disable Use Windows colors.

5. Select the desired color for the window background (if applicable), text background, and text color from the appropriate lists, and then click OK.

6. Click Apply.

Changing view fonts

Changing view colors



The Detail pane contains data items in columnar or icon format. With the exception of the first column of data in the Detail pane, the data items cannot be edited directly. The data in the first column can be edited directly or by using the shortcut menu and selecting Rename.

If you select List in the User Preferences dialog box, you can manipulate the columns and rows in the Detail pane as described in this table.

Sorting columns Click a column header to sort the items in the column alphabetically or numerically.

Sizing columns Automatically: To make the column width fit the contents, double-click the boundary to the right of the column heading. Manually: Drag the boundary on the right side of the column heading until the column is the desired width.

Editing the item name Click once on a row to highlight it, and then click again. The item name will be encased in an editing box so that you can rename the item. Double-click on a row to open the Properties dialog box, allowing you to edit the item name. Right-click on a row to display the shortcut menu; select Rename.

Editing a row Double-click on a row to open the Properties dialog box to edit the row’s information. Right-click on a row to display the shortcut menu; select Properties or other editing operations.

Copy, delete, or move rows Right-click on a row to display the shortcut menu; select Cut, Copy, Paste, or Delete.

You can select which materials are visible in the Materials list and how they display.

Working with columns and rows

Configuring the materials list



You can select exactly which materials you want displayed by setting a filter. Filters are used to sort the material names and display particular ones. For instance, you could filter the material list to display only those material names containing a certain word or words.

1. From the User Preferences dialog box, select the Materials tab.

2. In the Material Name Filtering area, select the desired filtering option:

None – Disables material filtering; the Material Name field is disabled.

Exact match – Lists materials with names that match the filter text.

Containing – Lists materials with names that contain the filter text.

First – Lists only those materials with names that begin with the filter text.

Last – Lists only those materials with names that end with the filter text.

3. In the Material Name box, type the text to use as a filter.

4. Click Apply. The materials are reordered, with the filter applied.

Enabling material name filtering



You can display the materials in list form (default) by type or by class. If you choose to display by type or class, you can select to display only certain types or classes of materials.

1. From the User Preferences dialog box select the Materials tab.

2. In the Materials Display Format area select the desired display format:

• List (default) Displays the materials in alphabetical list form (as shown)

• By Type Displays the materials by their type (for example; Finished, Intermediate, or Raw) or you can select all three to display the materials in a hierarchy view by type (as shown).

Configuring the material display



• By Class Displays the materials by their class designation (for example; Colorings, Flavorings, etc.) or you can select all classes to display the materials in a hierarchy view by class (as shown).

3. Click Apply. The Material list is refreshed, with the display format applied.

You do not have to select a Material Server after installation. It is done automatically. However, in a case where the server becomes disabled or is removed from the system, you must select a different server, which you can do easily from the Editor.

1. From the Tools menu, select System Configuration. The System Configuration dialog box opens.

2. Click the Browse button. The Select Computer dialog box opens.

3. Select the new server from the list of computers.

4. Click OK to return to the Server Options dialog box. The system configuration information is updated from the Network Editor of the selected server.

5. Click OK to exit System Options.

Selecting another Material Server



The report printing feature of the Editor allows you to print lists of the materials, containers, and other items in the database, in a report formatted with headers, footers and column headings (in list reports). There are two report formats available: formatted and list. The header (at the top of the page) consists of the report name, while the footer (at the bottom of the page) contains the date and time of printing and the page count.

A formatted report presents the information down the page, with bold field names as shown in this figure.

A list report presents the data in a columnar, spreadsheet format, with one line per data item. The field names become column headings as shown in this figure.

You can customize the reports by setting margins, changing font styles, and selecting text colors. In addition, you can enter custom text that is also included in the footer. (See Setting report preferences for more information.)

The Print Preview function of the Editor allows you to see how a printed report will look before you send it to the printer.

1. Click the Print Preview button. The Print Preview window opens, displaying the report as it will look when printed. The following options are available from the Print Preview window:

• Next Page – If there is more than one page in the report, click Next Page to view the next page of the report.

• Prev Page – Click to view the previous report pages (if there is more than one page in the report).

• Two Page – Allows you to view two pages of a report in the same window.

• One Page – Returns to the default preview setting of one page per window.

• Zoom In/Out – Click Zoom In to magnify the preview page. Click Zoom Out to reduce the size of the page in the preview window.

• Close – Closes the preview window.

2. Click Close to return to the Editor. You can either print the report or make additional report configuration changes.

Generating printed reports

Previewing reports



1. In the Editor’s Hierarchy pane, select the list or item(s) that you want to print.

2. From the File menu, click Print. You could also click the Print button or press CTRL+P to display the Print dialog box.

3. Ensure that the correct printer is selected, and click OK.

Tip To configure heading and footer fonts, and add a custom footer to your reports, see Setting report preferences for instructions.

Printing a Range of Reports

Occasionally, you may want to print just certain pages of the report. You can do so by entering the starting and ending page numbers of the section you want printed.

1. In the Editor’s Hierarchy pane, select the list or item(s) that you want to print.

2. Click Print.

3. In the Page Range area, click Pages. Type the page numbers to print in the From and To boxes.

4. Ensure that the correct printer is selected and click OK.

Printing reports



You can define a footer to print on every page of the report and select the font and color (if your printer supports color printing) for the various sections of the report.


2. Select the Reports tab. The default report style for most views is Formatted.

Setting report preferences



The Reports tab contains the following items:

Item Description

Report column Lists the report templates available for the item or view that is currently active in the Editor.

List check box Enables the list report style, if available for the associated report.

Formatted check box Enables the formatted report style, which is the default format for most reports.

Include Related Data check box Adds any additional data associated with the selected item to the printed report.

Footer Text Prints the word or phrase entered at the bottom of each report page.

List Reports button Formatted Reports button

Opens the Report Page Configuration dialog box where you can set the margins, font, and text color for a specific report template.

Graphical Reports button Not enabled in Material Manager.

1. To change the type of printed report, select either List or Formatted to the right of the appropriate report.

Tip: If you select the List format, set the page orientation to landscape. From the File menu, select Print Setup, select Landscape in the Orientation area, and then click OK.

2. Where available, you can select Include Related Data, and any additional data associated with the selected item (single items only – not lists or groups) also prints on the report.

3. In the Footer Text box, type a word or phrase to appear centered at the bottom of each page.

4. Click Apply.



1. To change the margins, fonts, and colors of a printed report, click the desired Report button (List, Formatted, or Graphical). The Report Page Configuration dialog box opens.

2. Change the margin widths of the printed report if desired. Type the desired amounts in each box for the Left, Right, Top, and Bottom margins. A visual representation of each margin change displays in the Report page preview area. Note that this is not to scale.

3. If you want to use inches instead of metric measurements, disable Metric Measurements.

4. Click OK to close the Report Page Configuration dialog box.

5. Click Apply.

Changing margins



You can change the font type, style, and size of each section in the report template.

1. From the Formatted Report Page Configuration dialog box, select the Fonts tab.

Setting the report fonts and colors



There are four areas in a report for which you can edit the fonts and colors:

• Heading – Prints across the top of each page, generally in a larger, bolder font than the rest of the report.

• Sub Heading – Refers to the field names, such as Material Name or Group. In formatted reports, sub headings print to the left of the actual report data.

• Body – Refers to the actual report data text, which is usually smaller and lighter than the headings.

• Footing – Prints the page number, date, and time that the report is printed across the bottom of each page, generally in a smaller font than the rest of the report.

2. Click the button for the report section you want to edit. The Font dialog box opens.

3. Select the desired font, font style, and size, and then click OK.



4. If your printer supports color printing, you can add color to the report. Select the Colors tab.

5. Click the color selection button corresponding to the report section to which you want to add color. The Color dialog box opens.

6. Select a color from the Color dialog box, and then click OK. You will see a visual representation of each color change in the Report page preview area of the dialog box.

7. Repeat for the other sections of the report, as desired. When you are finished changing fonts and colors, click OK to close the Report Page Configuration dialog box.

8. Click Apply.


Chapter 3

Configuring states

The state of a lot informs others about the availability of a material. When a lot of material is assigned the state of Ready To Use, it can be distributed to its configured containers and used in a recipe. You can use lot states to keep certain lots of material from being used in a recipe. For instance, you can assign a Rejected state to a material that does not conform to standards. Since the state is not Ready to Use, the FactoryTalk Batch Server does not use the material.

The same rule applies to the state of a container. If a container is not Ready To Use, you cannot distribute material to that container, either as an addition of material from a container to a recipe, or the distribution of material to a container from the recipe. You can use container states to keep certain containers from being used. For example, when a container needs a maintenance check, assign the Maintenance state. Since the state is not Ready to Use, the FactoryTalk Batch Server does not use the container.

The States Configuration option allows you to pre-configure descriptive information about the lot and container states, but not report an actual quantity of that lot or container.

Tip: The FactoryTalk Batch Server can bind a recipe only to a material or container that is Ready To Use.

Chapter 3 Configuring states


1. From the Edit menu, select States. The States Configuration dialog box opens to the Lot tab.

Tip: You cannot edit or delete the system-defined Ready To Use state.

2. If you are creating a container state, select the Container tab. If you are creating a lot state, skip this step.

3. Click the New State button. The Create Lot (or Container) State dialog box opens.

4. In the Name box, type a unique name for the state.

5. In the Description box, type a detailed description of the state.

6. The Controller ID field defaults to the next numeric value in sequence, or you can change it to a unique number. This ID is provided to allow the PLC programmer to access a sublot record from the material database.

7. Click OK to save the new state.

Creating new states

Configuring states Chapter 3


1. From the States Configuration dialog box, select the Lot or Container tab.

2. Select the record row to edit, and then click the Edit State button. The Edit Lot (or Container) State dialog box opens.

3. Make the necessary changes, and then click OK.

1. From the States Configuration dialog box, select the Lot or Container tab.

2. Select the record row to delete, and then click the Delete State button.

Tip: You cannot delete a lot state that is assigned to a material. You must either edit the material to assign a different state or delete the material. Additionally, you cannot delete a container state that is assigned to a container. You must either edit the container to assign a different state or delete the container.

Editing states

Deleting states


Chapter 4

Configuring material types

A material type is the descriptive state of a material. The Material Manager has three default material types:

• Finished is a process output (final product such as vanilla ice cream), which is the quantity of a material that is distributed after the execution of a recipe.

• Raw is a process input, which is the quantity of material, such as milk or eggs, added for the execution of a recipe.

• Intermediate can be both a process input or a process output.

Chapter 4 Configuring material types


1. From the Edit menu, select Material Types. The Material Types dialog box opens.

2. Click the Add button. The Edit Material Type dialog box opens.

3. In the Name box, type a unique name for the selected material.

4. In the Description box, type a detailed description of the selected material.

5. The Controller ID field defaults to the next numeric value in sequence. If necessary, you can change this to a unique number, which is used for PCD phase programming. (See the FactoryTalk Batch PCD Programmer Technical Reference Guide for more information.)

6. Click OK to save the new material type.

Creating material types

Configuring material types Chapter 4


1. From the Material Types dialog box, select the type, and then click the Edit button.

2. Make the necessary changes to the material type information, and then click OK.

Use this procedure to delete material types.

To delete material types:

1. From the Material Types dialog box, select the type, and then click Delete.

2. If Confirm deletion is enabled on the User Preferences dialog box, a confirmation message opens. To delete the type, click Yes.

If Confirm deletion is disabled on the User Preferences dialog box, the material type is deleted without a confirmation message. (See Configuring the Material Editor for more information.)

Tip: You cannot delete a material type that is assigned to a material. You must either edit the material to assign a different type or delete the material.

See also

Configuring the Material Editor on page 13

Editing material types

Delete material types


Chapter 5

Configuring material classes

A material class defines one or more materials that are considered similar to each other. An example of a material class is Sweetener, which could contain the materials Granulated Sugar and Corn Syrup. Using material classes simplifies adding materials to storage containers — you can then add the whole class of materials to a container, instead of adding each material individually.

You can also define properties for material classes, which propagate to all materials created with reference to a material class. For example, if the material brown sugar is based on the sweeteners material class, which has defined material class properties, such as color and melting temperature, then brown sugar automatically inherits those material class properties. You can then modify the inherited material class properties by deleting inherited properties that do not pertain to the material, or change the minimum, maximum, and default values.

Chapter 5 Configuring material classes


1. From the Edit menu, select Material Classes. The Material Classes dialog box opens listing the currently defined material classes.

2. Click the Add button. The Create Material Class dialog box opens to the General tab.

3. In the Name box, type a unique name for the new class.

4. In the Description box, type a detailed description for the new class.

5. The Controller ID field defaults to the next numeric value in sequence. If necessary, you can change this to a unique number, which is used for PCD phase programming. (See the FactoryTalk Batch PCD Programmer Technical Reference Guide for more information.)

6. Click Apply to save the changes. The Edit Material Class dialog box opens.

Creating material classes

Configuring material classes Chapter 5


7. Select the Properties tab, and then click the New Property button.

The following is a list of the items in the Properties tab.

Item Description

Material Class Property Unique name assigned to the material class property. When a class is assigned to a material, all property names (class properties and independent properties) must be unique. Names of material class properties cannot be the same as material properties that belong to a material assigned to the class. (See Adding material properties for more information.)

Type Represents the data type from which the provided value is to be derived. There are three data types supported: Real, Integer, and String.

Minimum Minimum value for the material class property. Cannot be greater than the maximum value.

Maximum Maximum value for the material class property. Cannot be less than the minimum value.

Default Value Default value for the material class property. Must be between Minimum and Maximum values.

EUs Engineering unit of measure for the material class property.

Controller ID Defaults to the next numeric value in sequence. If necessary, you can change this to a unique number to be used for PCD phase programming.

Synchronize Select to propagate changes to all inherited material and lot properties. This selection is necessary only when you make changes to a material property.

Description Detailed description of the material class property.

8. Type the information in the appropriate boxes to define the material class property.

9. Click Apply to save the changes, or click OK to save the record and close the dialog box.



1. From the Material Classes dialog box, select the class, and then click the Edit button. The Edit Material Class dialog box opens.

2. Make necessary changes, and then click Apply.

Editing material classes



Use this procedure to edit material class properties.

To edit material class properties:

1. If you need to change the material class properties, select the Properties tab from the Edit Material Class dialog box. The currently defined material class properties display in a table format. You can also use a form to make changes. See Using a form to edit material class properties for more information.

2. Make the desired changes. You cannot change the Type.

Important: If you are changing a value that contains a decimal, use the Delete key to delete the value before typing a new value containing a decimal. If you type over the old value containing the decimal, the new decimal is not recognized by the application.

3. If you want to propagate the changes to all material and lot properties that are based on this material class, select Synchronize.


See also

Using a Form to Edit Material Class Properties on page 46

Edit material class properties



1. On the Properties tab, select the record row to edit, and then click the Edit Property button. The Edit Material Class Property dialog box opens.

2. Make the desired changes. You cannot change the Type.

Important: If you are changing a value that contains a decimal, use the Delete key to delete the value before typing a new value that contains a decimal. If you type over the old value containing the decimal, the new decimal is not recognized by the application.

3. If you want to propagate the changes to all material and lot properties that are based on this material class, select Synchronize.

4. Click OK.

1. From the Material Classes dialog box, select the class, and then click Delete.

2. If the Confirm deletion is enabled on the User Preferences dialog box, a confirmation message opens. To delete the class, click Yes.

If the Confirm deletion is disabled on the User Preferences dialog box, the material class is deleted without a message. (See Configuring the Material Editor for more information.)

Important: You cannot delete a material class that is assigned to a material. You must either assign a different material class to the material or delete the material.

Using a form to edit material class properties

Deleting material classes



1. From the Material Classes dialog box, select the class, and then click the Edit button. The Edit Material Class dialog box opens.

2. Select the Properties tab.

3. Select the record row to delete, and then click the Delete Property button.


Deleting material class properties


Chapter 6

Configuring materials

The Material Editor is used to facilitate easy configuration and manipulation of the material-based recipes database. Material configuration is the process of adding, editing and deleting various material data that is stored in the material database.

When adding materials, you must create a general description record of the material before you can define the other attributes of the material.

1. Right-click Materials in the Hierarchy pane and select New Material (or click the New toolbar button). The Create Material dialog box opens.

Creating a material record

Chapter 6 Configuring materials


The following is a list of items in the Create Material dialog box:

Item Description

Name Unique name assigned to the material (required).

Description Detailed description of the material.

Inventory Key Provides an interface for integrating in-house material inventory systems to plant production processes.

Engineering Units The unit of measure being used for this material.

Type The Material Type to which this material belongs (required). Defaults to Raw material type.

Class The Material Class to which this material belongs (required). Defaults to Ungrouped material class.

Default Lot State All lots derived from this material default to this state.

Controller ID Defaults to the next numeric value in sequence. If necessary, you can change this to a unique number to be used for PCD phase programming.

Last Edited By System name of the user who last changed the material record (view-only).

Last Modified Date and time record last modified based on the system date and time (view-only).

2. Type the information in the appropriate boxes to define the material.

3. Click Apply to save the information. The Edit Material dialog box opens.

Configuring materials Chapter 6


The Edit Material dialog box contains the following tabs:

• Properties: A list of custom attributes that are associated with the material. This data is optional information and is not required. (See "Configuring material properties" for more information.)

• Lots: The information that identifies a particular quantity of a material. A lot holds all of the static information about the lot, such as Lot Identifier, Material Type, State of the lot, Engineering Units, and Controller ID value). (See Configuring Material Lots for more information.)

• Containers: The definition of some type of storage that holds materials. Some containers hold one material (such as a bin or tank), and others can hold multiple materials (such as a pallet). Containers can be a source for materials (adding materials from the container) or the destination for materials (such as the distribution of a finished product). (See "Configuring containers" for more information.)

• Priorities: Used to select which container of material you want to use first. For example, a container that has the oldest material must be used before newer materials. In the Priorities column, the default priority value is 100. The allowed values are 1 to 100, with 1 being the lowest value, which is selected first. You can assign as many priorities per container as needed. If the container with the value of 1 runs out of material, the next priority for that container is used. (See Configuring material priorities for more information.)

• Inventory: A view of the material lot distribution. Each row represents a sublot. A sublot is an amount of material in the selected lot that has been distributed to a container. The container, lot, and label are used by the FactoryTalk Batch Server when searching for a material to bind to a recipe. (See Configuring material inventory for more information.)



The Properties tab contains a list of custom attributes that are associated with the material. This data is optional information and is not required. Custom attributes always have indexes starting at 1000. Since a material could be composed of numerous property elements, you can add numerous property records. Additionally, it allows you to edit existing properties and delete properties from the list.

For materials that might have the same custom properties, you can duplicate properties with the same Controller ID to multiple containers. For example, if two materials have a pH_Factor property, you can assign the property to both materials using the same Controller ID.

Use this procedure to add material properties.

To add material properties:

1. If the Edit Material dialog box is open, click the Properties tab.

If not, right-click on a material in the Hierarchy or Detail pane, and select Properties. The Edit Material dialog box opens. Click the Properties tab.

2. Click the New Property button to create a new property record row.

Configuring material properties

Adding material properties



The following is a list of items on the Properties tab:

Item Description

Material Property Unique name assigned to the material property (required). All property names (material class properties and independent material properties) must be unique. Names of material class properties cannot be the same as material properties that belong to a material assigned to the class. See Creating material classes for more information.

Class Property Name of the inherited material class property (view only).

Type Represents the data type that the provided value is to be derived from (required). There are three data types supported: Real, Integer, and String.

Minimum Minimum value for the material property. Cannot be greater than the maximum value.

Maximum Maximum value for the material property. Cannot be less than the minimum value.

Default Value The default value for the material property. Must be greater than the minimum value and less than the maximum value for the material property.

EUs Engineering unit of measure for the material property.

Controller ID ID numbers begin at 1000 and increment by 10 for each attribute added. If necessary, you can change this to a unique number to be used for PCD Phase Programming.

Description Detailed description of the material property.

3. Type the information in the appropriate boxes to define the material property.

4. Click Apply to save the record, or click OK to save the record and close the dialog box.

See also

Creating Material Classes on page 42



1. If the Edit Material dialog box is open, select the Properties tab.

If not, right-click on a material in the Hierarchy or Detail pane, and select Properties. The Edit Material dialog box opens. Select the Properties tab. The currently defined material properties display in a table format. You can also use a form to make changes.

For inherited material class properties, you can change only the minimum, maximum, and default values.

2. Modify the material property as desired.



Tip: Changing a duplicate property that is assigned to other materials does not affect the other properties.

Editing material properties



1. On the Properties tab, select the record row to edit, and then click the Edit Property button. The Edit Material Class Property dialog box opens.

2. Modify the material property as desired, and then click OK.



Tip: Changing a duplicate property that is assigned to other materials does not affect the other properties.

1. From the Edit Materials dialog box, select a record row to delete, and then click the Delete Property button.


Tip: Deleting a duplicate property that is assigned to another material does not affect the other material’s property.

Using a form to edit material properties

Deleting material properties



The Lots tab contains the information that identifies a particular quantity of a material. A lot holds all of the static information about the lot, such as Lot Identifier, Material Type, State of the lot, Engineering Units, and Controller ID value. A lot may also contain sublots, which detail the actual quantity of the lot that is distributed into material storage containers. An example of a lot could be: Shipment number SN2009 of the material Granulated Sugar, which is part of the material class Sweetener and is classified as a Raw material type.

1. From the Edit Material dialog box, select the Lots tab. Existing lots display in ascending order by lot name. You can sort the list by clicking the column header to display an up arrow (ascending) or down arrow (descending).

2. Click the New Lot button to insert a new lot record row.

The following is a list of items on the Lots tab:

Item Description

Lot Name Unique name to identify the lot (required).

State Current state of the lot (required).

Quantity Total amount of this lot of material (required).

Creation Date Date and time the lot was added (view-only).

Depletion Date Date and time the lot was deleted (view-only).

Controller ID Defaults to the next numeric value in sequence. You can change this to a unique number for PCD phase programming.

Description Detailed description of the lot record.

Refresh button Re-queries the materials database for lots of this material and repopulates the displayed lot records.

3. Type the information in the appropriate boxes to define the material lot.


Configuring material lots

Adding new lots



1. From the Edit Material dialog box, select a record row to delete, and then click the Delete Lot button.

2. Click Apply to save, or click OK to save and close the dialog box.

You can change the material’s properties and the amount of material in the lot, and distribute a lot of material to a container.

1. From the Edit Material dialog box, select a record row to edit, and then click the Edit Lot button. The Edit Lot dialog box opens to the General tab.

2. Modify the general lot information as needed, and then click Apply.

3. Select the Properties tab. The properties assigned to the lot of material display. You can change the value of the property directly in the Value column or use a form.

Deleting lots

Editing a lot



4. In the Value box, type a new value for the property.



1. On the Properties tab, select the record row to edit, and then click the Edit Property button. The Edit Lot Property dialog box opens.

2. In the Value box, type the value of the property, and then click OK.


Using a form to change lot properties



When you distribute a lot, you create a sublot that is identified by a label. A sublot is an amount of material in the selected lot that is distributed to a container.

Tip: Before creating distributions, verify that both the material lot and container have a state of Ready to Use.

1. From the Edit Lot dialog box, select the Storage tab. Existing sublots display in ascending order by label name. Each record row represents a sublot. You can sort the list by clicking the column header to display an up arrow (ascending) or down arrow (descending).

2. Select the record row to distribute, and then click the Distribute button. The Distribute Lot dialog box opens.

3. In the Label box, type a unique name for the sublot.

4. In the Quantity box, type the amount to distribute.

5. From the Storage Container list, select a container to store the distributed amount.

6. Click OK to return to the Storage tab on the Edit Lot dialog box.


Distributing a lot



1. From the Edit Lot dialog box, select the Storage tab. The distributed amounts of the lot display.

Tip: If you edit a sublot by distributing the lots of material, deleting a distribution, or changing the amount of material, the material's inventory information also changes.

2. Select the record row to edit, and then click the Edit Distribution button.

3. In the Quantity box, type a new amount.


4. Click OK to return to the Storage tab on the Edit Lot dialog box.


1. From the Edit Lot dialog box, select the Storage tab.

2. Select the record row to delete, and then click the Delete Distribution button.


Changing a sublot quantity

Deleting a sublot



A container is some type of storage that holds materials. Some containers, such as a bin or tank, hold one material, while others, such as a pallet, can hold multiple materials. Containers can be a source for materials (adding materials from the container) or the destination for materials (such as the distribution of a finished product).

From the Containers tab you can add or remove source containers, by location or individually, to the material’s Configured Containers list. When you distribute the material you select a container from the list. Only the containers configured to hold the lots of this material are used in the execution of a recipe.

If the containers are not configured, the Source Containers list only displays the virtual container. There are two methods you can use to configure containers:

• Create the containers first, create the materials second, and then assign containers to materials.

• Create materials first and assign them to the virtual container. As you create the containers, reassign the materials. (See Configuring storage containers for more information.)

1. From the Edit Material dialog box, select the Containers tab.

Configuring containers

Assigning containers to materials



2. There are three methods you can use to move containers from the Source Containers list to the Configured Containers list.

• To add a storage location of containers, select a location from the Source Containers list, and then click the Add Location button. All the containers assigned to that location are added to the Configured Containers list.

• To add an individual container, expand the location group to display the containers assigned to that location. Select an individual container, and then click the Add button.

• To add all the source containers to the configured containers, click the Add All button.


Removing a container merely unassigns the material from that container. The container definition still exists in the material database.

1. There are three methods you can use to move containers from the Source Containers list to the Configured Containers list.

• To remove a single container, select the container in the Configured Containers list, and then click the Remove button.

• To remove more than one container, select the container in the Configured Containers list, hold down either the Shift key or the CTRL key, select other containers to remove, and then click the Remove button.

• To remove all the containers in the Configured Containers list, click the Remove All button.


Removing a container



The priorities of a material are used to select a container of material that you want to use first; for example, a container that has the oldest material needs to be used before newer materials. In the Priorities column, the default priority value is 100. The allowed values are 1 to 100, with 1 being the lowest value, which is selected first. You can assign as many priorities per container as needed. If the container with the value of 1 runs out of material, the next priority for that container is used.

The Priorities tab displays area model data, which is loaded into the material database by a FactoryTalk Batch Server during start up. If no information is visible, then the database does not contain the area model data.

1. From the Edit Material dialog box, select the Priorities tab. Existing containers assigned to the material display in ascending order by container name. You can sort the list by clicking the column header to display an up arrow (ascending) or down arrow (descending).

2. In the Priority box, type a value from 1 to 100.

3. Click Apply to save the changes, or click OK to save the changes and close the dialog box.

Configuring material priorities



The Inventory tab displays a view of the material lot distribution. Each row represents a sublot. A sublot is an amount of material in the selected lot that is distributed to a container. The container, lot, and label are used by the FactoryTalk Batch Server when searching for a material to bind to a recipe. When the recipe is complete, the FactoryTalk Batch Server updates the amount to reflect the amount of material either consumed from the container (Addition) or added to the container (Distribution). You configure the container type in the FactoryTalk Batch Equipment Editor. (See the FactoryTalk Batch Equipment Editor User Guide for more information).

When you edit, distribute, or delete a distribution in a material’s inventory, the results also affect the container’s inventory.

1. From the Edit Material dialog box, select the Inventory tab. Existing sublots display in ascending order by label name. Each record row represents a sublot. You can sort the list by clicking the column header to display an up arrow (ascending) or down arrow (descending).

Configure material inventory

Changing a sublot quantity



2. Select the record row, and then click the Edit Distribution button. The View Lot Distribution dialog box opens.

3. In the Quantity box, type a new amount.


4. Click OK to return to the Inventory tab on the Edit Lot dialog box.


1. From the Edit Material dialog box, select the Inventory tab.

2. Select the row to delete, and then click the Delete Distribution button.


Deleting a sublot



Managing lot distribution from the Inventory tab gives you an opportunity to adjust the inventory levels in containers.

1. From the Edit Material dialog box, select the Inventory tab.

2. Select the record row, and then click the Distribute button. The Distribute Lot dialog box opens.

3. In the Label box, type a unique name for the sublot.


5. From the Storage Container list, select a container to store the distributed amount.

6. Click OK to return to the Inventory tab on the Edit Lot dialog box.

7. Click Apply to save the changes or click OK to save the changes and close the dialog box.

1. In either the Hierarchy pane or Detail pane, right-click the material to delete, and then click the Delete button.

2. If the Confirm deletion user preference is enabled, you are asked to verify the deletion. To delete the material, click Yes; to cancel the deletion, click No.

If the Confirm deletion user preference is disabled, the selection is deleted without a confirmation message.

(See Configuring the Material Editor for more information.)

Managing inventory distribution

Deleting materials


Chapter 7

Configuring storage containers and locations

Independent containers are the actual elements that contain the lot(s) of material(s) that are used by FactoryTalk Batch in the execution of a recipe. A material storage container can be anything that either contains or acts as a location for lots of material (tank farm, vessel, or pallet). The containers can either be grouped within material storage locations for convenience or can remain as independent containers.

Each material storage location is an independent entity that represents the location of the containers where lots of materials are stored. Locations can contain a grouping of containers related to that location. Examples of locations are warehouses and plants. What is important about material storage locations is the knowledge of what lot(s) of material(s) reside in or on that particular location. If you make changes to the configuration in the plant, you have to open the area model, make the changes, save it and restart the server. By using storage locations, you can feed material from a location instead of an independent container. By moving the container from location to location in the material database, you will not need to modify the equipment database.

Chapter 7 Configuring storage containers and locations


You can add storage containers individually or to the Independent Containers group. When adding a container, a general description of the container must be created before you can define the properties of the container. There are three types of containers: Composite, Plug Flow, and Pallet.

Composite

Plug Flow

Pallet

Description Contains like material Contains multiple sublots layered in vessel

Contains multiple materials

# of materials container may hold

1 1 n

# sublots container may hold

1 n n

Access to sublots Sequential Sequential Random

Sublots trackable? No; anything added is combined with original sublot

Yes; assumption is that active sublot is at bottom of vessel

Yes; any sublot is always accessible

• A composite container holds more than one lot, but the lots are mixed. You cannot distinguish between lots, therefore the lot IDs do not matter, and you will not keep inventory on the lot. For example, a tank can be filled with one lot of milk. When another lot of milk is added, the two lots become mixed, and are, therefore, indistinguishable from one another.

• A plug flow container holds one type of material, but is comprised of two or more different lots. The first lot that went in is the first to come out. For example, you can add a lot of grain to a silo containing another lot of grain and the two lots remain separate (for the most part). Each lot can be inventoried.

• A pallet can have multiple materials, which usually are bags of a specific quantity of material. For example, a pallet could be stacked with 100 pound bags of flour, sugar, and cocoa.

Configuring storage containers

Configuring storage containers and locations Chapter 7


1. Right-click Independent Containers, and then select New Material Storage Container. The Create Material Storage Container dialog box opens to the General tab.

The following is a list of the items on the General tab of the Create Material Storage Container dialog box:

Item Description

Name Unique name assigned to the container.

Description Detailed description of the container (optional).

Capacity Amount of material a storage container can hold.

Heel Quantity of material remaining in a container when emptied. For a container to be considered a binding candidate for material additions, the total inventory of the container must be greater than the heel value. The heel is not applicable to material distributions. (See Using container heel properties for more information.)

Engineering Unit Unit of measure for the material (optional).

Storage Location Location where the container is added.

State State of the container indicating the availability of a material.

Controller ID If left at 0 (zero), defaults to the next numeric value in sequence. You can assign a unique number for PCD phase programming.

Container Type Type of container: Composite, Plug Flow, or Pallet.

Tip: If you want to use a container for phase binding, its State must be set to Ready to Use, otherwise the FactoryTalk Batch Server will not view the container as eligible for binding.

2. Type the information in the appropriate boxes to define the container.

3. Click Apply. The Edit Material Storage Container dialog box opens to the General tab. Once you created the general container record, you can configure the container properties, priority data, materials, and contents.

Important: When you add a new container or modify an existing container in the Material Editor, the area model is not automatically updated. To update the area model open the Equipment Editor.

Creating a storage container



The Properties tab contains a list of custom attributes that can be associated with the container. This data is optional information and is not required. Custom attributes always have indexes starting at 1000. Since a container class can also be represented as a collection of containers, the Properties tab allows you to add numerous records to make a collection.

For containers that might have the same custom properties, you can duplicate properties with the same Controller ID to multiple containers. For example, if two containers have a pH_Factor property, you can assign the property to both containers using the same Controller ID.

1. From the Edit Material Storage Container dialog box, select the Properties tab.

2. Click the New Property button to insert a new property record row.

The following is a list of the items on the Properties tab:

Item Description

Property Name Unique name assigned to the property (required).

Type Represents the data type for the provided value (required). There are three data types supported: Real, Integer, and String.

Value The value of the container property.

Eng. Units The unit of measure being used for the material.

Controller ID ID numbers begin at 1000 and increment by 10 for each attribute added. You can change the controller ID to a unique number for use in PCD phase programming.

Description Detailed description of the container property.

3. Type the information in the appropriate boxes to define the container properties.


Configuring container properties



1. From the Edit Material Storage Container dialog box, select a record number to edit and click the Edit Property button.

2. Modify the container property as needed, and then click OK.



1. From the Edit Material Storage Container dialog box, select a record row to delete, and then click the Delete Property button.

2. Click Apply to save the changes to the properties, or click OK to save the changes and close the dialog box.

Editing container properties

Deleting container properties



From the Materials tab you can add or remove source materials, by group or individually, to the container.

1. From the Edit Material Storage Container dialog box, select the Materials tab.

2. There are three methods you can use to move materials from the Source Materials list to the Configured Materials list.

• To add a group of materials, select a group from the Source Materials list, and then click the Add Class button. All the materials assigned to that class are added to the Configured Materials list.

• To add a single material, expand a material group to display the materials. Select a material, and then click the Add button.

• To add all the source materials to the configured materials, click the Add All button.


Configuring container materials



Removing a material merely unassigns the material from that container. The material definition still exists in the material database.

1. There are three methods you can use to move materials from the Configured Materials list to the Source Materials list.

• To remove a single material, select the material in the Configured Containers list, and then click the Remove button.

• To remove more than one material, select a material in the Configured Materials list, hold down either the shift key or the ctrl key, select other materials to remove, and then click the Remove button.

• To remove all the materials in the Configured Materials list, click the Remove All button.


Removing a material



The priorities of a container are used to select materials that you want to use first. For example, the oldest material needs to be used before newer materials are used in a recipe, so you can set priority values for each container. The default priority value is 100. The allowed values are 1 to 100, with 1 being the lowest value, which is selected first. You can assign as many priorities per material as needed. If the container with a value of 1 runs out of material, the next priority container for that material is used.

The Priorities tab displays area model data loaded into the material database by a FactoryTalk Batch Server during start up. If no information is visible, then the database does not contain the area model data.

1. From the Edit Material Storage Container dialog box, select the Priorities tab.

The following is a list of items in the Priorities tab:

Item Description

Material Unique name of the material stored in the container (view-only).

Priority The priority ranking of the container (required).

Area The area model name loaded by the FactoryTalk Batch Server (view-only).

Cell The cell class instance configured in the area model, that has the container assigned to it (view-only).

Unit The unit class instance configured in the area model that has the container assigned to it (view-only).

Usage The type of usage configured in the area model, which determines if the container is an addition of material, distribution, or both (view-only).

2. In the Priority column, select a record row to edit, and then type a value from 1 to 100.


Configuring container priorities



The Inventory tab displays a view of the distribution of the lots of material in the selected container. Each row represents a sublot. A sublot is an amount of material in the selected lot that has been distributed to a container. The material, lot, and label are used by the FactoryTalk Batch Server when searching for a material to bind to a recipe.

When you edit, distribute, or delete a distribution in a container’s inventory, the results also affect the material’s inventory.

1. From the Edit Material Storage Container dialog box, select the Inventory tab. The list of sublots for the storage container displays.

2. Select the record row to edit, and then click the Edit Distribution button. The View Lot Distribution dialog box opens.

3. In the Quantity box, type a new amount, and then click OK.


From the Edit Material Storage Container dialog box, select the record row to delete, and then click the Delete Distribution button.

Configuring container inventory

Changing inventory quantity

Deleting a distribution



When you distribute a sublot of material, the distributed sublot appears with the Label, Container, and Amount distributed in the inventory of the selected storage container and also in the materials inventory.

1. From the Edit Material Storage Container dialog box, select the record row to distribute, and then click the Distribute button. The Distribute Lot dialog box opens.

2. In the Label box, type a unique label name for the sublot.


4. From the Storage Container list, select a container to use for storing the distributed amount.

5. Click OK to return to the Inventory tab. If you distributed the lot into the container in which you are working, the new sublot displays, with the Label, Container, and Amount distributed in the inventory.

Distributing a lot



When a sublot of a lot of material is used up, the sublot is deleted from the database. You can create a new quantity of that same sublot, using the Create Distribution button.

1. From the Edit Material Storage Container dialog box, click the Create Distribution button. The Create Lot Distribution dialog box opens.

2. In the Label box, type a unique label name for the sublot.

3. In the Quantity box, type the amount being distributed.

4. In the Material Lots list, select a lot of material to distribute.

5. Click OK to save the changes and close the dialog box.

1. In either the Hierarchy or Detail pane, right-click a container, and then select Properties. The Edit Material Storage Container dialog box opens to the General tab. The container name displays in the title bar.

2. Make the necessary changes to the storage container.


3. Click OK to save the changes.

Adding a new quantity of material to a deleted sublot

Editing storage containers



1. In either the Hierarchy pane or Detail pane, right-click a container, and then select Delete.

2. If Confirm deletion is enabled on the User Preferences dialog box, a confirmation message displays. To delete the storage container, click Yes.

If Confirm deletion is disabled on the User Preferences dialog box, the storage container is deleted without a confirmation message. (See Configuring the Material Editor for more information on defining the user preferences.)

Storage locations represent the locations of actual material storage containers. When adding new locations, you must add a record of the location before you can configure it.

1. In the Hierarchy pane, right-click Locations, and then select New Material Storage Location. The Create Material Storage Location dialog box opens.

2. In the Name box, type a unique name for the material.

3. In the Description box, type a detailed description of the material.

4. In the Controller ID box, type a unique number if desired. If left at 0 (zero), the Controller ID defaults to the next numeric value in sequence.

5. Click OK to save the new location and close the dialog box.

6. In either the Hierarchy or Detail pane, right-click the storage location, and then select New Material Storage Container.

7. Configure the material storage containers for this storage location. (See Configuring storage containers for more information.)

Deleting storage containers

Creating storage locations



1. In either the Hierarchy or Detail pane, right-click a storage location, and then select Properties. The Edit Material Storage Location dialog box opens to the General tab.

2. Make any necessary changes to the general information, and then click Apply.

3. Select the Materials tab. The materials assigned to this storage location display.

To make any changes to the list of configured materials, you need to edit the storage container located in the storage location. (See Editing storage containers for more information.)

Editing storage locations



4. To view material properties, double-click a material. The View Material dialog box opens.

You only can view the material’s property values. To edit the values, use the Edit Material dialog box. (See Creating a Material Record for more information.)

5. Click Close to close the dialog box.

Tip: You cannot delete a material storage location that has material storage containers assigned to it. You must either reassign or delete the containers, and then you can delete the storage location.

1. To delete a location, right-click on a location and select Delete.

2. If Confirm deletion is enabled on the User Preferences dialog box, a confirmation message about the selected location opens. To delete the location, click Yes.

If Confirm deletion is disabled on the User Preferences dialog box, the storage location is deleted without a confirmation message. (See Configuring the Material Editor for more information on defining the user preferences.)

Deleting storage locations


Chapter 8

Using container heel properties

The container heel is the specified quantity of inventory within a container that cannot be removed as part of a material addition. For material addition binding, the container is effectively empty when inventory drops below this level.

Material distributions do not have a use for the heel property. When the total amount of inventory in the container is less than the heel property, the container is not empty. The selection of the container for a material distribution must follow the binding rules for distribution binding by container type.

For a container to be considered a binding candidate for a material addition step, the total of all inventory of the same material within a container must be greater than the container’s heel property.

When the quantity of inventory within a container is less than the heel property, the container will not be considered available for binding. This prevents containers that are effectively empty from being reselected to add material to a batch.

Composite Container Example:

Composite containers have only one sublot. The total inventory is the quantity of that sublot.

Plug-Flow Container Example:

Plug-Flow containers may only contain one material, but may have many sublots. The sublots are assigned ascending ordinal values as they are put into the container. Sublots are assumed to be consumed in ordinal order, lowest to highest value, thus creating a first in/first out (FIFO) queue of inventory. Consumption may span multiple sublots.

Chapter 8 Using container heel properties


Total inventory is the sum of all sublots within the Plug-Flow container.

Pallet Container Example:

Pallet containers may contain any number of materials, and may have many sublots. In the example below, there are six sublots of Salt and two sublots of Pepper. The sublots are assigned ascending ordinal values by material as they are put into the container. Sublots are assumed to be consumed in ordinal order, lowest to highest value, thus creating a first out, first in queue of inventory. Consumption may span multiple sublots.

Total inventory is the sum of all sublots of the same material within the within the Pallet container. The example pallet has three total inventory values; Salt: 600 pounds, Pepper: 200 pounds and Sugar: 80 pounds. The heel property, 99 pounds, is applied to each of these materials. Considering only the Total Inventory/Heel Property rule, this pallet would be a binding candidate for material specifications for Salt and Pepper, but not Sugar.

Using container heel properties Chapter 8


The container heel property of a container supports being downloaded to phase logic. The 7800, 17800, 8000 and 18000 series phase requests to download data from the Material Database are used to download the heel property of any container.

The container heel property of a container supports being uploaded from phase logic. The 7800, 17800, 8000 and 18000 series phase requests to upload data from the Material Database are used to upload a value to the heel property of any container.

The 7800, 17800, 83NN, 183NN, 87NN and 187NN phase requests require an integer to identify the property to be referenced. For containers, the Heel Property will have an index of 10.

The Container object has been updated to include a property called heel.

Assigning a new heel property, like all material objects, requires replacing the whole container:

InsertContainer(objContainer as Container)

or updating an existing container by updating the whole object:

UpdateContainer(objContainer as Container)

Accessing the heel property from phase logic

Material object model support for heel property


Legal Notices

Copyright notice





Trademark Notices




Legal Notices



Legal Notices


Warranty












A accessing the heel property 83 adding

material properties 52 new quantity to deleted sublot 77 new tools 56

assigning containers 61

C changing

a sublot quantity 60, 64 colors 15 fonts 16 inventory quantity 75 margins 28 view colors 19 view fonts 19 view properties 18

configuring container inventory 75 container materials 72 container priorities 74 container properties 74 containers 61 material classes 41 material inventory 64 material lots 56 material priorities 63 material properties 52 material types 38 materials 49 states 33 storage containers 68 storage containers and locations 67 the material display 22 the Material Editor 13 the material list 20

creating a material record 49 a storage container 69 material classes 42 material types 38 new states 34 storage locations 78

D deleting

a distribution 75 a sublot 60, 65 container properties 71 lots 57 material class properties 47 material classes 46 material properties 55 material types 39 materials 66 states 35 storage containers 78 storage locations 80

detail pane 10 distributing a lot 59, 76

E editing

a lot 57 container properties 71 information tips 17 material class propertes 45 material classes 44 material properties 54 material types 39 states 35 storage containers 77 storage locations 79

Editor interface 7 enabling 21

G generating printed reports 24

H hierarchy pane 10

L list view 11

Index

Index


M managing inventory distribution 66 material object model support for heel property 83 menu bar 8

P previewing reports 24 printing reports 25

R removing

a container 62 a material 73

S selecting another 23 setting

general preferences 14 report fonts and colors 29 report preferences 26 user preferences 13

status bar 12

T toolbars 9

U using

a form to change lot properties 58 a form to edit material class properties 46 a form to edit material properties 55 container heel properties 81 the Material Editor 7

W working with columns and rows 20

Reference Guide

FactoryTalk® Batch Material Server API Technical

Rockwell Automation Publication FactoryTalk Batch Material Server API Technical Reference Guide - February 2017 3

Table of contents

Chapter 1

Document Organization ..................................................................................................... 7 Material Server API overview ............................................................................................. 8 Material object model descriptions.................................................................................... 9 Available interface definitions ......................................................................................... 10

Chapter 2

CreateTestResult ................................................................................................................ 15 DeleteContainer ................................................................................................................. 16 DeleteContainerMaterial ................................................................................................. 17 DeleteContainerProperty ................................................................................................. 17 DeleteContainerState........................................................................................................ 18 DeleteErrorCorrection ..................................................................................................... 18 DeleteLimit ......................................................................................................................... 19 DeleteLot ............................................................................................................................. 19 DeleteLotProperty ............................................................................................................. 20 DeleteLotState .................................................................................................................... 20 DeleteMaterial .................................................................................................................... 21 DeleteMaterialClass .......................................................................................................... 21 DeleteMaterialClassProperty .......................................................................................... 22 DeleteMaterialProperty .................................................................................................... 22 DeleteMaterialType ........................................................................................................... 23 DeleteStorageLocation ...................................................................................................... 23 DeleteSubLot ...................................................................................................................... 24 DeleteTestResult ................................................................................................................ 24 DeleteTestSpecification .................................................................................................... 25 DistributeSubLot ............................................................................................................... 25 GetContainer ...................................................................................................................... 26 GetContainerByControllerID ........................................................................................ 27 GetContainerByID ............................................................................................................ 27 GetContainerList ............................................................................................................... 28 GetContainerOrStorageLocationMaterials ................................................................. 29 GetContainerPriortyListByContainer .......................................................................... 29 GetContainerPriorityListByMaterial ............................................................................ 30 GetContainers .................................................................................................................... 30 GetContainersHavingMaterial ....................................................................................... 31 GetContainerState ............................................................................................................. 31 GetContainerStateList ...................................................................................................... 32 GetContainerStates ........................................................................................................... 33 GetErrorCorrection .......................................................................................................... 33 GetErrorCorrections ......................................................................................................... 34

Introducing Material Server API

Material interface definitions

Table of contents

4 Rockwell Automation Publication FactoryTalk Batch Material Server API Technical Reference Guide - February 2017

GetLot .................................................................................................................................. 34 GetLotList ........................................................................................................................... 35 GetLots ................................................................................................................................. 36 GetLotState ......................................................................................................................... 36 GetLotStateList .................................................................................................................. 37 GetLotStates........................................................................................................................ 38 GetMaterial ......................................................................................................................... 38 GetMaterialByControllerID ........................................................................................... 39 GetMaterialByID ............................................................................................................... 39 GetMaterialClass ................................................................................................................ 40 GetMaterialClassByID ..................................................................................................... 40 GetMaterialClasses ............................................................................................................ 41 GetMaterialClassList ......................................................................................................... 41 GetMaterialList .................................................................................................................. 42 GetMaterials ........................................................................................................................ 43 GetMaterialsInMaterialClasses ....................................................................................... 43 GetMaterialType ................................................................................................................ 44 GetMaterialTypeByID ...................................................................................................... 44 GetMaterialTypeList ......................................................................................................... 45 GetMaterialTypes .............................................................................................................. 46 GetStorageLocation ........................................................................................................... 46 GetStorageLocationByID ................................................................................................. 47 GetStorageLocationList .................................................................................................... 47 GetStorageLocations ......................................................................................................... 48 InsertContainer .................................................................................................................. 48 InsertContainerMaterial .................................................................................................. 48 InsertContainerProperty .................................................................................................. 49 InsertContainerState ......................................................................................................... 49 InsertErrorCorrection ....................................................................................................... 50 InsertErrorCorrectionResult ........................................................................................... 50 InsertLimit ........................................................................................................................... 51 InsertLot .............................................................................................................................. 51 InsertLotState ..................................................................................................................... 52 InsertMaterial ..................................................................................................................... 52 InsertMaterialClass ............................................................................................................ 53 InsertMaterialClassProperty ............................................................................................ 53 InsertMaterialProperty ..................................................................................................... 54 InsertMaterialType ............................................................................................................ 54 InsertStorageLocation ....................................................................................................... 55 InsertSubLot ....................................................................................................................... 55 InsertTestSpecification ..................................................................................................... 56 IsBatchServer....................................................................................................................... 56 IsLotAuthor ........................................................................................................................ 57 IsMaterialAuthor ............................................................................................................... 57 IsMaterialServerAvailable ................................................................................................. 58 IsMaterialViewer ................................................................................................................ 58 MapMaterialClassProperty .............................................................................................. 59

Table of contents


MaterialClassProperties .................................................................................................... 59 UpdateContainer ............................................................................................................... 60 UpdateContainerPriority ................................................................................................. 60 UpdateContainerProperty ............................................................................................... 61 UpdateContainerState ...................................................................................................... 61 UpdateErrorCorrection.................................................................................................... 62 UpdateErrorCorrectionResult ........................................................................................ 62 UpdateLimit ........................................................................................................................ 63 UpdateLot ........................................................................................................................... 63 UpdateLotProperty ........................................................................................................... 64 UpdateLotState .................................................................................................................. 64 UpdateMaterial .................................................................................................................. 65 UpdateMaterialClass ......................................................................................................... 65 UpdateMaterialClassProperty ......................................................................................... 66 UpdateMaterialProperty .................................................................................................. 66 UpdateMaterialType ......................................................................................................... 67 UpdateStorageLocation .................................................................................................... 67 UpdateSubLot .................................................................................................................... 68 UpdateTestResult .............................................................................................................. 68 UpdateTestSpecification .................................................................................................. 69 Legal Notices ....................................................................................................................... 71

Legal Notices Index


Chapter 1

Introducing Material Server API

This information was developed to provide quick and easy access to information regarding the interface between the Material Server and the Material Editor and FactoryTalk® Batch. It is intended to be used as a reference guide by those who want to develop custom interfaces.

The information in this document is presented in an order that should minimize the effort required to locate information on the Material Server API (Application Programming Interface).

The following subjects are presented in this document:

• Material Server API overview on page 8

• Material interface definitions on page 15

Document Organization

Chapter 1 Introducing Material Server API


The Material Server API is the interface between the Material Server, the Material Editor, and FactoryTalk Batch. Using the material object model (MOM) you can develop a custom user interface application.

The material object model provides the interface to the Material Server:

Material Server API overview

Introducing Material Server API Chapter 1


The following section describes the objects that comprise the material object model.

Object Description

Container Represents a single Container record from the material database. The Container object also can be represented as a collection of Containers. The Container object contains collections for ContainerMaterials, ContainerProperties, and SubLots. Each Container object can contain 1 to N ContainerMaterial, ContainerProperty, and SubLot collections.

ContainerMaterial Represents a single ContainerMaterial record from the material database. The ContainerMaterial object also can be represented as a collection of ContainerMaterials.

ContainerProperty Represents a single ContainerProperty record from the material database. The ContainerProperty object also can be represented as a collection of ContainerProperties. No methods are associated with this object.

ContainerState Represents a single ContainerState record from the material database. The ContainerState object also can be represented as a collection of ContainerStates.

Lot Represents a single Lot record from the material database. The Lot object also can be represented as a collection of Lots. The Lot object contains collections for LotProperties, and SubLots. Each Lot object can contain 1 to N LotProperties, and SubLots collections.

LotProperty Represents a single LotProperty record from the material database. The LotProperty object also can be represented as a collection of LotProperties. No methods are associated with this object.

LotState Represents a single LotState record from the material database. The LotState object also can be represented as a collection of LotStates.

Material Represents a single material record from the material database. The material class also can be represented as a collection of Materials. The Material object contains collections for MaterialProperties, Lots, and SubLots. Each Material object can contain 1 to N MaterialProperties, Lots, and SubLots collections.

MaterialType Represents a single MaterialType record from the material database. The MaterialType object also can be represented as a collection of MaterialTypes.

MaterialClass Represents a single MaterialClass record from the material database. The MaterialClass object also can be represented as a collection of MaterialClasses.

MaterialProperty Represents a single MaterialProperty record from the material database. The MaterialProperties collection can contain from 1 to N MaterialProperty objects. No methods are associated with this object.

MaterialSvr Provides methods that can be executed to perform some specific task of the Material Server. There are no properties available from this class. Although this class acts as an independent entity, it is the base class that is used to expose the lower level Material Manager classes.

StorageLocation Represents a single StorageLocation record from the material database. The StorageLocation object also can be represented as a collection of StorageLocations. The StorageLocation object contains collections for StorageLocationMaterials. Each StorageLocation object can contain 1 to N StorageLocationMaterials collections.

SubLot Represents a single SubLot record from the material database. The SubLot object also can be represented as a collection of SubLots.

Material object model descriptions



Three methods are assumed to be available for every collection class in the material object model.

Method Description

Count Returns the number of items in the collection.

Item Returns a reference to an item in the collection via the index of the item.

NewEnum Delegates an enumerator to the collection object. This allows for the use of "For...Each" statements to iterate through the members of the collection.

The following is a list of all supported interface definitions in the material object model:

Item Description

CreateTestResult on page 15 Inserts a QA test result record associated with a test specification into the material database.

DeleteContainer on page 16 Deletes a Container from the material database.

DeleteContainerMaterial on page 17 Deletes a ContainerMaterial from the material database.

DeleteContainerProperty on page 17 Deletes a ContainerProperty from the material database.

DeleteContainerState on page 18 Deletes a ContainerState from the material database.

DeleteErrorCorrection on page 18 Deletes a QA error correction record associated with a test specification in the material database.

DeleteLimit on page 19 Deletes a QA test specification limit record associated with a base test specification in the material database.

DeleteLot on page 19 Deletes a Lot record from the material database.

DeleteLotProperty on page 20 Deletes a LotProperty from the material database.

DeleteLotState on page 20 Deletes a LotState from the material database.

DeleteMaterial on page 21 Deletes a Material record from the material database.

DeleteMaterialClass on page 21 Deletes a MaterialClass record from the material database.

DeleteMaterialClassProperty on page 22 Deletes a MaterialClassProperty record from the material database.

DeleteMaterialProperty on page 22 Deletes a MaterialProperty record from the material database.

DeleteMaterialType on page 23 Deletes a MaterialType record from the material database.

DeleteStorageLocation on page 23 Deletes a StorageLocation record from the material database.

DeleteSubLot on page 24 Deletes a SubLot record from the material database.

DeleteTestResult on page 24 Deletes a QA test result record associated with a test specification in the material database.

DeleteTestSpecification on page 25 Deletes a QA test specification record from the material database.

DistributeSubLot on page 25 Distributes all or a portion of a Lot’s total quantity to a Container. Also distributes or redistributes portions of existing SubLots to other Containers.

GetContainer on page 26 Returns a Container object with its properties populated with corresponding data from the material database, based on the Container Name.

Available interface definitions



Item Description

GetContainerByControllerID on page 27 Returns a Container object populated with the specified Container data from the material database, based on the ControllerID.

GetContainerByID on page 27 Returns a Container object with its properties populated with corresponding data from the material database, based on the ContainerID.

GetContainerList on page 28 Returns a list of Containers in a multi-dimensioned array.

GetContainerOrStorageLocationMaterials on page 29

Returns a collection of ContainerMaterial objects that are configured for use with a specified Container or StorageLocation.

GetContainerPriortyListByContainer on page 29

Returns a collection of 1 to N ContainerPriority objects.

GetContainerPriorityListByMaterial on page 30 Returns a collection of 1 to N ContainerPriority objects.

GetContainers on page 30 Returns a collection of 1 to N Container objects.

GetContainersHavingMaterial on page 31 Returns a collection of 1 to N MaterialContainer objects.

GetContainerState on page 31 Returns a ContainerState object with its properties populated with corresponding data from the material database, based on the ContainerState Name.

GetContainerStateList on page 32 Returns a list of ContainerStates in a multi-dimensioned array.

GetContainerStates on page 33 Returns a collection of 1 to N ContainerState objects.

GetErrorCorrection on page 33 Gets an instance of an ErrorCorrection object based on the name of the error correction passed to the interface.

GetErrorCorrections on page 34 Gets a list of QA error corrections and presents it to the user as a collection of ErrorCorrection objects.

GetLot on page 34 Returns a Lot object populated with the specified Lot data from the material database, based on the Lot name.

GetLotList on page 35 Returns a list of Lot objects in a multi-dimensioned array.

GetLots on page 36 Returns a collection of 1 to N Lot objects.

GetLotState on page 36 Returns a LotState object populated with the specified LotState data from the material database, based on the LotState name.

GetLotStateList on page 37 Returns a list of LotStates in a multi-dimensioned array.

GetLotStates on page 38 Returns a collection of 1 to N LotState objects.

GetMaterial on page 38 Returns a Material object populated with the specified Material data from the material database, based on the Material name.

GetMaterialByControllerID on page 39 Returns a Material object populated with the specified Material data from the material database, based on the ControllerID.

GetMaterialByID on page 39 Returns a Material object with its properties populated with corresponding data from the material database, based on the MaterialID.

GetMaterialClass on page 40 Returns a MaterialClass object that is populated with the specified MaterialClass data from the material database, based on the MaterialClass name.

GetMaterialClassByID on page 40 Returns a MaterialClass object with its properties populated with corresponding data from the material database, based on the MaterialClassID.

GetMaterialClasses on page 41 Returns a collection of 1 to N MaterialClass objects.

GetMaterialClassList on page 41 Returns a list of Material objects in a multi-dimensioned array.

GetMaterialList on page 42 Returns a list of Material objects in a multi-dimensioned array.

GetMaterials on page 43 Returns a collection of 1 to N Material objects.



Item Description

GetMaterialType on page 44 Returns a Type object populated with the specified MaterialType data from the material database based on the MaterialType Name.

GetMaterialTypeByID on page 44 Returns a MaterialType object with its properties populated with corresponding data from the material database, based on the MaterialTypeID.

GetMaterialTypeList on page 45 Returns a list of MaterialType objects in a multi-dimensioned array.

GetMaterialTypes on page 46 Returns a collection of 1 to N MaterialType objects.

GetStorageLocation on page 46 Returns a StorageLocation object populated with the specified StorageLocation data from the material database, based on the Storage Location name.

GetStorageLocationByID on page 47 Returns a StorageLocation object with its properties populated with corresponding data from the material database, based on the StorageLocationID.

GetStorageLocationList on page 47 Returns a list of StorageLocations in a multi-dimensioned array.

GetStorageLocations on page 48 Returns a collection of 1 to N StorageLocation objects.

InsertContainer on page 48 Inserts a Container record into the material database.

InsertContainerMaterial on page 48 Inserts a ContainerMaterial record into the material database.

InsertContainerProperty on page 49 Inserts a ContainerProperty record into the material database.

InsertContainerState on page 49 Inserts a Container State record into the material database.

InsertErrorCorrection on page 50 Inserts a QA error correction record associated with a test specification in the material database.

InsertErrorCorrectionResult on page 50 Inserts a QA error correction result record associated with a test result in the material database.

InsertLimit on page 51 Inserts a QA test specification limit record associated with a base test specification in the material database.

InsertLot on page 51 Inserts a Lot record into the material database.

InsertLotState on page 52 Inserts a Lot State record into the material database.

InsertMaterial on page 52 Inserts a Material record into the material database.

InsertMaterialClass on page 53 Inserts a MaterialClass record into the material database.

InsertMaterialClassProperty on page 53 Inserts a MaterialClassProperty record into the material database.

InsertMaterialProperty on page 54 Inserts a MaterialProperty record into the material database.

InsertMaterialType on page 54 Inserts a Material Type record into the material database.

InsertStorageLocation on page 55 Inserts a StorageLocation record into the material database.

InsertSubLot on page 55 Inserts a SubLot record into the material database.

InsertTestSpecification on page 56 Inserts a QA test specification record into the material database.

IsLotAuthor on page 57 Returns a Boolean value (TRUE or FALSE) indicating if the current user has rights to the Lot Author security role.

IsMaterialAuthor on page 57 Returns a Boolean value (TRUE or FALSE) indicating if the current user has rights to the Material Author security role.

IsMaterialServerAvailable on page 58 Returns a Boolean value (TRUE or FALSE) indicating if there is communications to the Material Server.

IsMaterialViewer on page 58 Returns a Boolean value (TRUE or FALSE) indicating if the current user has rights to the Material Viewer security role.

MapMaterialClassProperty on page 59 Maps a MaterialClassProperty record to the material definition in the material database.



Item Description

MaterialClassProperties on page 59 Returns a collection of MaterialClassProperty objects that are derived from the material class upon which they are based.

UpdateContainer on page 60 Updates a Container record in the material database.

UpdateContainerPriority on page 60 Updates a ContainerPriority record in the material database.

UpdateContainerProperty on page 61 Updates a ContainerProperty record in the material database.

UpdateContainerState on page 61 Updates a ContainerState record in the material database.

UpdateErrorCorrection on page 62 Updates a QA error correction record associated with a test specification in the material database.

UpdateErrorCorrectionResult on page 62 Updates a QA error correction result record associated with a test result in the material database.

UpdateLimit on page 63 Updates a QA test specification limit record associated with a base test specification in the material database.

UpdateLot on page 63 Updates a Lot record in the material database.

UpdateLotProperty on page 64 Updates a LotProperty record in the material database.

UpdateLotState on page 64 Updates a LotState record in the material database.

UpdateMaterial on page 65 Updates a Material record in the material database.

UpdateMaterialClass on page 65 Updates a Class record in the material database.

UpdateMaterialClassProperty on page 66 Updates a MaterialClassProperty record in the material database.

UpdateMaterialProperty on page 66 Updates a MaterialProperty record in the material database.

UpdateMaterialType on page 67 Updates a MaterialType record in the material database.

UpdateStorageLocation on page 67 Updates a StorageLocation record in the material database.

UpdateSubLot on page 68 Updates a SubLot record in the material database.

UpdateTestResult on page 68 Updates a QA test result record associated with a test specification in the material database.

UpdateTestSpecification on page 69 Updates a QA test specification record in the material database.


Chapter 2

Material interface definitions

This section describes all public interface definitions for the material object model.

Inserts a QA test result record associated with a test specification in the material database.

Syntax

TestSpecification.CreateTestResult(TestResult As TestResult, Lot As Lot)

The CreateTestResult method syntax has these parts:

Part Description

TestSpecification Instance of the TestSpecification interface to which the method is directed.

TestResult An instance of a TestResult object.

Lot An instance of the Lot object that the test specification is being executed against.

Remarks

This interface allows for the creation of QA test results in the material database.

CreateTestResult

Chapter 2 Material interface definitions


Deletes a Container from the material database.

Syntax

MaterialSvr.DeleteContainer(Container As Container, [ActivityDescription As String])

The DeleteContainer method syntax has these parts:

Part Description

MaterialSvr Instance of the MaterialServer Interface to which the method is directed.

Container An instance of a Container object.

ActivityDescription Adds descriptive text to the activity journal for this operation. (Optional)

Remarks

Along with the deletion of the Container, all associated ContainerProperties, ContainerPriorities, ContainerMaterials and Promises are deleted from the database when this method is executed.

Containers cannot be deleted if they are in use by any SubLot in the material database.

The ‘Virtual Container’ is a system-defined Container which cannot be deleted via this method or any other means.

DeleteContainer

Material interface definitions Chapter 2


Deletes a ContainerMaterial from the material database.

Syntax

Container.DeleteContainerMaterial(ContainerMaterial As ContainerMaterial, [ActivityDescription As String])

The DeleteContainerMaterial method syntax has these parts:

Part Description

Container Instance of the Container object to which the method is directed.

ContainerMaterial An instance of a ContainerMaterial object.


Deletes a ContainerProperty from the material database.

Syntax

Container.DeleteContainerProperty(ContainerProperty As ContainerProperty, [ActivityDescription As String])

The DeleteContainerProperty method syntax has these parts:

Part Description


ContainerProperty An instance of a ContainerProperty object.


DeleteContainerMaterial

DeleteContainerProperty



Deletes a ContainerState from the material database.

Syntax

MaterialSvr.DeleteContainerState(ContainerState As ContainerState)

The DeleteContainerState method syntax has these parts:

Part Description


ContainerState An instance of a ContainerState object.

Remarks

A ContainerState can only be deleted if no Containers are using it. There is no provision in this method to override this functionality or un-associate the Containers that are using the ContainerState.

The ‘Ready To Use’ ContainerState is system-defined and cannot be deleted via this interface or any other means.

Deletes a QA error correction record associated with a test specification in the material database.

Syntax

MaterialSvr.DeleteErrorCorrection(ErrorCorrection As ErrorCorrection)

The DeleteErrorCorrection method syntax has these parts:

Part Description

MaterialSvr Instance of the MaterialSvr interface to which the method is directed.

ErrorCorrection An instance of an ErrorCorrection object.

Remarks

This interface allows for the deletion of QA error corrections from the material database.

DeleteContainerState

DeleteErrorCorrection



Deletes a QA test specification limit record associated with a base test specification in the material database.

Syntax

TestSpecification.DeleteLimit(TestSpecificationLimit As TestSpecificationLimit)

The DeleteLimit method syntax has these parts:

Part Description

TestSpecification Instance of the QATestSpec interface to which the method is directed.

TestSpecificationLimit An instance of a TestSpecificationLimit object.

Remarks

This interface allows for the deletion of a QA test specification limit record from the material database.

Deletes a Lot record from the material database.

Syntax

Material.DeleteLot(Lot As Lot, [ActivityDescription As String])

The DeleteLot method syntax has these parts:

Part Description

Material Instance of the Material object to which the method is directed.

Lot An instance of a Lot object.


Remarks

Along with deleting the Lot, this interface will delete SubLots and LotProperties associated with the specified Lot.

DeleteLimit

DeleteLot



Deletes a LotProperty from the material database.

Syntax

Lot.DeleteLotProperty(LotProperty As LotProperty, [ActivityDescription As String])

The DeleteLotProperty method syntax has these parts:

Part Description

Lot Instance of a Lot object to which the method is directed.

LotProperty An instance of a LotProperty object.


Deletes a LotState from the material database.

Syntax

MaterialSvr.DeleteLotState(LotState As LotState)

The DeleteLotState method syntax has these parts:

Part Description


LotState An instance of a LotState object.

Remarks

A LotState can only be deleted if no Lots are using it. There is no provision in this method to override this functionality, nor is there a way to un-associate the Lots that are using the LotState.

The ‘Ready To Use’ LotState is system-defined and cannot be deleted.

DeleteLotProperty

DeleteLotState



Deletes a Material record from the material database.

Syntax

MaterialSvr.DeleteMaterial(Material As Material, [ActivityDescription As String])

The DeleteMaterial method syntax has these parts:

Part Description


Material An instance of a Material object.


Remarks

Along with the deletion of the Material, all associated MaterialProperties, LotProperties, Lots, and SubLots are deleted from the database.

Deletes a MaterialClass record from the material database.

Syntax

MaterialSvr.DeleteMaterialClass(MaterialClass As MaterialClass)

The DeleteMaterialClass method syntax has these parts:

Part Description


MaterialClass An instance of a MaterialClass object.

Remarks

A MaterialClass can only be deleted if there are no Materials using it. There is no provision in this method to override this functionality or disassociate the Materials that are using the MaterialClass.

DeleteMaterial

DeleteMaterialClass



Deletes a MaterialClassProperty record from the material database.

Syntax

MaterialClass.DeleteMaterialClassProperty(MaterialClassProperty As MaterialClassProperty), [ActivityDescription As String])

The DeleteMaterialClassProperty method syntax has these parts:

Part Description

MaterialClass Instance of the MaterialClass object to which the method is directed.

MaterialClassProperty An instance of a MaterialClassProperty object.


Remarks

Executing this interface will delete the MaterialClassProperty from the material database and remove all mapped material definition properties.

Deletes a MaterialProperty record from the material database.

Syntax

Material.DeleteMaterialProperty(MaterialProperty As MaterialProperty, [ActivityDescription As String])

The DeleteMaterialProperty method syntax has these parts:

Part Description


MaterialProperty An instance of a MaterialProperty object.


Remarks

Along with the MaterialProperty, all LotProperties associated with the specified MaterialProperty are deleted.

DeleteMaterialClass Property

DeleteMaterialProperty



Deletes a MaterialType record from the material database.

Syntax

MaterialSvr.DeleteMaterialType(MaterialType As MaterialType)

The DeleteMaterialType method syntax has these parts:

Part Description


MaterialType An instance of a MaterialType object.

Remarks

A Material Type can only be deleted if there are no Materials using it. There is no provision in this method to override this functionality or un-associate the Materials that are using the MaterialType. The MaterialTypes ‘Raw’, ‘Intermediate’, and ‘Finished’ are system-defined MaterialTypes and cannot be deleted.

Deletes a StorageLocation record from the material database.

Syntax

MaterialSvr.DeleteStorageLocation(StorageLocation As StorageLocation, [ActivityDescription As String])

The DeleteStorageLocation method syntax has these parts:

Part Description


StorageLocation An instance of a StorageLocation object.


Remarks

A StorageLocation can only be deleted if there are no Containers using it. There is no provision in this method to override this functionality, nor is there a way to un-associate the Containers that are using the StorageLocation.

DeleteMaterialType

DeleteStorageLocation



Deletes a SubLot record from the material database.

Syntax

MaterialSvr.DeleteSubLot(SubLot As SubLot, [ActivityDescription As String])

Lot.DeleteSubLot(SubLot As SubLot, [ActivityDescription As String])

The DeleteSubLot method syntax has these parts:

Part Description


Lot Instance of a Lot object to which the SubLots are to be deleted from.

SubLot An instance of a SubLot object.


Remarks

SubLots that are deleted do not have the effect of returning any of the remaining SubLot quantity back to the Lot in which the SubLot was created. In effect, the SubLot and any quantity are deleted from inventory.

This method is available in two locations within the material object model: the MaterialServer object and the Lot Object. Use the one that is appropriate for your needs.

Deletes a QA test result record associated with a test specification in the material database.

Syntax

TestSpecification.DeleteTestResult(TestResult As TestResult)

The DeleteTestResult method syntax has these parts:

Part Description



Remarks

This interface allows for the deletion of QA test results from the material database.

DeleteSubLot

DeleteTestResult



Deletes a QA test specification record from the material database.

Syntax

Material.DeleteTestSpecification(TestSpecification As TestSpecification, ForceDelete as Boolean)

The DeleteTestSpecification method syntax has these parts:

Part Description

Material Instance of the Material interface to which the method is directed.

TestSpecification An instance of a QATestSpec object.

ForceDelete TRUE | FALSE TRUE deletes the test specification and all details. FALSE deletes the test specification if there is no detail information. FALSE is the default for the argument, so the user must explicitly set to TRUE to cause a force delete to occur.

Remarks

This interface will not only delete the QA test specification — it will also delete all QA test specification details that are a part of the test specification.

The ForceDelete argument allows the user to delete a test specification and all associated test result data by setting the value to TRUE. If the value is set to FALSE and the test specification has associated test results, the test specification cannot be deleted.

Distributes all or a portion of a Lot’s total quantity to a Container. It also can be used to distribute or redistribute portions of existing SubLots to other Containers.

Syntax

SubLot.DistributeSubLot(ByVal Quantity As Double, ByVal Container As Long, [ByVal Label As String, [ActivityDescription As String])

The DistributeSubLot method syntax has these parts:

Part Description

SubLot Instance of the SubLot object to which the method is directed.

Quantity Represents the Quantity of the SubLot to distribute.

Container Represents the ContainerID of the Container that is being distributed to.

Label Represents the Label that can be applied to the distributed SubLot. (Optional)


DeleteTestSpecification

DistributeSubLot



Returns a Container object with its properties populated with corresponding data from the material database, based on the Container Name.

Syntax

Set object = MaterialSvr.GetContainer(ByVal ContainerName As String, UseCollection As Boolean)

The GetContainer method syntax has these parts:

Part Description

object Reference to a valid Container object.


ContainerName Name of the Container.

UseCollection True: The method attempts to locate the specified Container in a Container collection. If no collection is present, one is created and the record is read from the collection. If one is present, reading from a collection is much quicker than making a round trip to the database. If however there is no collection and one has to be constructed, this option may prove to be less optimal than reading from the database. False: The method reads the record directly from the database.

Remarks

Although this method loads the Container data of the Container object, this object contains a collection of ContainerProperties and ContainerMaterials. These collection objects are not populated until you explicitly call those properties on the Container object. The purpose for this is that pre-loading these collection objects is a performance hit that need not be taken unless those particular elements are required.

GetContainer



Returns a Container object populated with the specified Container data from the material database, based on the ControllerID.

Syntax

object = MaterialSvr.GetContainerByControllerID (ByVal ControllerID As Long)

The GetContainerByControllerID method syntax has these parts:

Part Description



ControllerID ControllerID of the Container being requested. It is expected that the program using this interface know the ControllerID for the data entity it wants to access.

Returns a Container object with its properties populated with corresponding data from the material database, based on the ContainerID.

Syntax

Set object = MaterialSvr.GetContainerByID(ByVal ContainerID As Long)

The GetContainerByID method syntax has these parts:

Part Description



ContainerID ID of the Container being requested.

Remarks

Although this method loads the Container data of the Container object, this object contains a collection of ContainerProperties and ContainerMaterials. These collection objects are not populated until you explicitly call those properties on the Container object. The purpose for this is that pre-loading these collection objects is a performance hit that need not be taken unless those particular elements are required.

GetContainerByControllerID

GetContainerByID



Returns a list of Containers in a multi-dimensioned array.

Syntax

vResult = MaterialSvr.GetContainerList(ByVal ContainerFilter As ContainerFilterEnum , ByVal FilterValue As String)

The GetContainerList method syntax has these parts:

Part Description

vResult The data returned by the Material Server.

MaterialSvr Instance of the MaterialServer Batch Interface to which the method is directed.

ContainerFilter An enumeration representing a set of pre-defined filters. Enumeration: 0 = GetAllContainers 1 = GetContainersNotInStorageLocation 2 = GetContainersInStorageLocation 3 = GetIndependantContainersAndStorageLocations 4 = GetAllContainersInAllStorageLocations

FilterValue A string representing the Storage Location name, used by the ContainerFilter to filter on.

Where vResult is:

Part Description

vResult Is a two dimensional array containing <Empty Array> | <ContainerData>

ContainerData Array Element [0] = ControllerID Array Element [1] = ConatinerName

GetContainerList



Returns a collection of ContainerMaterial objects that are configured for use with a specified Container or StorageLocation.

Syntax

MaterialSvr.GetContainerOrStorageLocationMaterials(ContainerOrStorageLocationName As String) As ContainerMaterials

The GetContainerOrStorageLocationMaterials method syntax has these parts:

Part Description


ContainerOrStorageLocationName

The instance of a Container or StorageLocation.

Remarks

Pass it the name of a Container or StorageLocation to get back a list of Materials that are configured for use with the specified Container or StorageLocation.


Syntax

Set object = MaterialSvr.GetContainerPriorityListByContainer(ContainerName As String)

The GetContainerPriorityListByContainer method syntax has these parts:

Part Description

object Reference to a valid ContainerPriorities collection object.


ContainerName String representing the name of the Container you want to produce the list from.

GetContainerOrStorage LocationMaterials

GetContainerPriortyList ByContainer




Syntax

Set object = MaterialSvr.GetContainerPriorityListByMaterial(MaterialName As String)

The GetContainerPriorityListByMaterial method syntax has these parts:

Part Description

object Reference to a valid ContainerPriorities collection object.


MaterialName String representing the name of the Material you want to produce the list from.

Returns a collection of 1 to N Container objects.

Syntax

Set object = MaterialSvr.GetContainers()

The GetContainers method syntax has these parts:

Part Description

object Reference to a valid Containers collection object.


GetContainerPriorityList ByMaterial

GetContainers



Returns a collection of 1 to N MaterialContainer objects.

Syntax

Set object = MaterialSvr.GetContainersHavingMaterial(IMaterialID As Long)

The GetContainersHavingMaterial method syntax has these parts:

Part Description

object Reference to a valid MaterialContainers collection object.


MaterialID Represents the ID of the Material.

Returns a ContainerState object with its properties populated with corresponding data from the material database, based on the ContainerState Name.

Syntax

Set object = MaterialSvr.GetContainerState(ByVal sName As String, UseCollection As Boolean)

The GetContainerState method syntax has these parts:

Part Description

object Reference to a valid ContainerState object.


sName Represents the name of the ContainerState.

UseCollection True: Attempts to locate the specified ContainerState in a pre-populated collection. If no collection is present, one is created and the record is read from the collection. False: Reads the record directly from the database.

GetContainersHaving Material

GetContainerState



Returns a list of ContainerStates in a multi-dimensioned array.

Syntax

vResult = MaterialSvr.GetContainerStateList()

The GetContainerStateList method syntax has these parts:

Part Description



Where vResult is:

Part Description

vResult Is a two dimensional array containing <Empty Array> | <ContainerStateData>

ContainerStateData Array Element [0] = PKid Array Element [1] = Name Array Element [2] = Description Array Element [3] = ControllerID

Remarks

In order to test for an empty array, you must test the upper and lower bounds of the vResult array. If both bounds are zero, then the array is empty and can be treated as such.

GetContainerStateList



Returns a collection of 1 to N ContainerState objects.

Syntax

Set object = MaterialSvr.GetContainerStates()

The GetContainerStates method syntax has these parts:

Part Description

object Reference to a valid ContainerStates collection object.


Gets an instance of an ErrorCorrection object based on the name of the error correction passed to the interface.

Syntax

MaterialSvr.GetErrorCorrection(sName AS String, UseCollection AS Boolean) As ErrorCorrection

The GetErrorCorrection method syntax has these parts:

Part Description


sName Name of the error correction being retrieved.

UseCollection Boolean that, when set to TRUE, determines if a collection of error corrections exist. If so, the name is used to search the collection to get the error correction instance. If FALSE is specified then the instance is retrieved directly from the material database. If a collection is loaded, this is the fastest search method.

Remarks

This interface provides you with the ability to get an instance of a particular error correction object by providing the error correction name.

GetContainerStates

GetErrorCorrection



Gets a list of QA error corrections and presents it to the user as a collection of ErrorCorrection objects.

Syntax

MaterialSvr.GetErrorCorrections( ) As ErrorCorrections

The GetErrorCorrections method syntax has these parts:

Part Description


Remarks

This interface provides you with a list of QA error corrections.

Returns a Lot object populated with the specified Lot data from the material database, based on the Lot Name.

Syntax

Set object = MaterialSvr.GetLot(ByVal sName As String, UseCollection As Boolean)

The GetLot method syntax has these parts:

Part Description

object Reference to a valid Lot object.


sName Represents the Lot Name.

UseCollection Boolean that, when set to TRUE, determines if a collection of error corrections exist. If so, the name is used to search the collection to get the error correction instance. If FALSE is specified then the instance is retrieved directly from the material database. If a collection is loaded, this is the fastest search method.

Tip: Because multiple Lots with the same name can exist in the material database this interface will return the first instance of the given Lot name so there is a possibility that the Lot returned will not be the Lot you are looking for. If this is the case, use the Material.Lots property to get a collection of Lots for a given material and loop through this collection to find the desired Lot.

GetErrorCorrections

GetLot



Returns a list of Lots. This is a string representing the material name that is used by the ContainerFilter to filter on in a multi-dimensioned array.

Syntax

vResult = MaterialSvr.GetLotList(ByVal LotFilter As LotFilterEnum, ByVal FilterValue As String)

The GetLotList method syntax has these parts:

Part Description



LotFilter An enumeration representing a set of pre-defined filters: 0 = GetAllLots 1 = ByMaterialName

FilterValue

Where vResult is:

Part Description

vResult Is a two dimensional array containing <Empty Array> | <LotData>

LotData Array Element [0] = PKid Array Element [1] = Lot Name Array Element [2] = Description Array Element [3] = ControllerID

Remarks

In order to test for an empty array, you must test the upper and lower bounds of the vContainerList array. If both bounds are zero, then the array is empty and can be treated as such.

GetLotList



Returns a collection of 1 to N Lot objects.

Syntax

Set object = MaterialSvr.GetLots()

The GetLot method syntax has these parts:

Part Description

object Reference to a valid Lots collection object.


Tip: Because multiple Lots with the same name can exist in the material database this interface will fail if multiple Lots with the duplicate names exist. Because the key of the Lot collection is Name and since each key has to be unique, if duplicate Lot names exist the collection will stop at the first occurrence of a duplicate. If this is the case, consider using the Material.Lots property to get a collection of Lots for a given Material and loop through this collection to find the desired Lot.

Returns a LotState object populated with the specified LotState data from the material database, based on the LotState’s name.

Syntax

Set object = MaterialSvr.GetLotState(ByVal sName As String, UseCollection As Boolean)

The GetLotState method syntax has these parts:

Part Description

object Reference to a valid LotState object.


sName Represents the name of the LotState.

UseCollection True: Attempts to locate the specified LotState in a pre-populated collection. If no collection is present, one is created and the record is read from the collection. False: Reads the record directly from the database.

GetLots

GetLotState



Returns a list of LotStates in a multi-dimensioned array.

Syntax

vResult = MaterialSvr.GetLotStateList()

The GetLotStateList method syntax has these parts:

Part Description



Where vResult is:

Part Description

vResult Is a two dimensional array containing <EmptyArray> | <LotStateData>

LotStateData Array Element [0] = PKID Array Element [1] = Name Array Element [2] = Description Array Element [3] = ControllerID

Remarks


GetLotStateList



Returns a collection of 1 to N LotState objects.

Syntax

Set object = MaterialSvr.GetLotStates()

The GetLotStates method syntax has these parts:

Part Description

object Reference to a valid LotStates collection object.


Returns a Material object populated with the specified Material data from the material database, based on the Material Name.

Syntax

Set object = MaterialSvr.GetMaterial(ByVal sName As String, UseCollection As Boolean)

The GetMaterial method syntax has these parts:

Part Description

object Reference to a valid Material object.


sName Represents the name of the Material.

UseCollection True: Attempts to locate the specified Material in a pre-populated collection. If no collection is present, one is created and the record is read from the collection. False: reads the record directly from the database.

GetLotStates

GetMaterial



Returns a Material object populated with the specified Material data from the material database, based on the ControllerID.

Syntax

object = MaterialSvr.GetMaterialByControllerID (ByVal IControllerID As Long)

The GetMaterialByControllerID method syntax has these parts:

Part Description



IControllerID ControllerID of the Material being requested. It is expected that the program using this interface know the ControllerID for the data entity it wants to access.

Returns a Material object with its properties populated with corresponding data from the material database, based on the MaterialID.

Syntax

Set object = MaterialSvr.GetMaterialByID(ByVal IMaterialID As Long)

The GetMaterialByID method syntax has these parts:

Part Description



IMaterialID Represents the ID of the Material.

GetMaterialByControllerID

GetMaterialByID



Returns a MaterialClass object that is populated with the specified MaterialClass data from the material database, based on the MaterialClass Name.

Syntax

Set object = MaterialSvr.GetMaterialClass(ByVal MaterialClassName As String, UseCollection As Boolean)

The GetMaterialClass method syntax has these parts:

Part Description

object Reference to a valid MaterialClass object.


MaterialClassName Represents the name of the MaterialClass.

UseCollection True: Attempts to locate the specified MaterialClass in a pre-populated collection. If no collection is present, one is created and the record is read from the collection. False: reads the record directly from the database.

Returns a MaterialClass object with its properties populated with corresponding data from the material database, based on the MaterialClassID.

Syntax

Set object = MaterialSvr.GetMaterialClassByID(ByVal MaterialClassID As Long)

The GetMaterialClassByID method syntax has these parts:

Part Description

object Reference to a valid MaterialClass object.


MaterialClassID Represents the ID of the MaterialClass.

GetMaterialClass

GetMaterialClassByID



Returns a collection of 1 to N MaterialClass objects.

Syntax

Set object = MaterialSvr.GetMaterialClasses()

The GetMaterialClasses method syntax has these parts:

Part Description

object Reference to a valid MaterialClasses collection object.


Returns a list of Materials in a multi-dimensioned array.

Syntax

vResult = MaterialSvr.GetMaterialClassList()

The GetMaterialClassList method syntax has these parts:

Part Description


MaterialSvr Instance of the MaterialServer to which the method is directed.

Where vResult is:

Part Description

vResult Is a two dimensional array containing <EmptyArray> | <MaterialClassData>

MaterialClass Data

Array Element [0] = PKID Array Element [1] = MaterialClass Name Array Element [2] = Description Array Element [3] = ControllerID

Remarks


GetMaterialClasses

GetMaterialClassList



Returns a list of Materials in a multi-dimensioned array.

Syntax

vResult = MaterialSvr.GetMaterialList(MaterialFilter As MaterialFilterEnum, FilterValue As String)

The GetMaterialList method syntax has these parts:

Part Description



MaterialFilter An enumeration representing a set of pre-defined filters: 0 = GetAllMaterials 1 = GroupName 2 = ClassificationName 3 = MaterialName

FilterValue A string representing the filter value.

Where vResult is:

Part Description

vResult Is a two dimensional array containing <EmptyArray> | <MaterialData>

MaterialData Array Element [0] = Pkid Array Element [1] = Name Array Element [2] = Description Array Element [3] = ControllerID

Remarks


GetMaterialList



Returns a collection of 1 to N Material objects.

Syntax

Set object = MaterialSvr.GetMaterials()

The GetMaterials method syntax has these parts:

Part Description

object Reference to a valid Materials collection object.


Returns a list of the submitted material class names with their configured materials.

Syntax

Set object = MaterialSvr.GetMaterialsInMaterialClasses()

The GetMaterialsInMaterialClasses method syntax has these parts:

Part Description

object Reference to a valid Materials collection object.


GetMaterialsInMaterialClasses takes a tab-delimited string of material class names and returns a two-dimensional string array, with the first dimension being the submitted material class name and the second being the name of the material, if any, supported by that container.

The material classes are returned in the order that they were requested in the tab-delimited string.

If a material class has no materials configured for it, an empty string will be returned for the configured material.

If an invalid container name is submitted, the method will not fail, but will return ***** for the configured material name.

GetMaterials

GetMaterialsInMaterial Classes



Returns a Type object populated with the specified MaterialType data from the material database based on the MaterialType Name.

Syntax

Set object = MaterialSvr.GetMaterialType(ByVal MaterialTypeName As String, UseCollection As Boolean)

The GetMaterialType method syntax has these parts:

Part Description

object Reference to a valid Classification object.


MaterialTypeName Represents the name of the Material Type.

UseCollection True: Attempts to locate the specified MaterialType in a pre-populated collection. If no collection is present, one is created and the record is read from the collection. False: Reads the record directly from the database.

Returns a MaterialType object with its properties populated with corresponding data from the material database, based on the MaterialTypeID.

Syntax

Set object = MaterialSvr.GetMaterialTypeByID(ByVal MaterialTypeID As Long)

The GetMaterialTypeByID method syntax has these parts:

Part Description

object Reference to a valid MaterialType object.


MaterialTypeID Represents the ID of the MaterialType.

GetMaterialType

GetMaterialTypeByID



Returns a list of MaterialTypes in a multi-dimensioned array.

Syntax

vResult = MaterialSvr.GetMaterialTypeList()

The GetMaterialTypeList method syntax has these parts:

Part Description



Where vResult is:

Part Description

vResult Is a two dimensional array containing <EmptyArray> | <MaterialTypeData>

Material Classification Data

Array Element [0] = Pkid Array Element [1] = Name Array Element [2] = Description Array Element [3] = ControllerID

Remarks


GetMaterialTypeList



Returns a collection of 1 to N MaterialType objects.

Syntax:

Set object = MaterialSvr.GetMaterialTypes()

The GetMaterialTypes method syntax has these parts:

Part Description

object Reference to a valid MaterialTypes collection object.


Returns a StorageLocation object populated with the specified StorageLocation data from the material database, based on the Storage Location Name.

Syntax

Set object = MaterialSvr.GetStorageLocation(ByVal sName As String, UseCollection As Boolean)

The GetStorageLocation method syntax has these parts:

Part Description

object Reference to a valid StorageLocation object.


sName Represents the ID of the StorageLocation record from the material database.

UseCollection True: Attempts to locate the specified StorageLocation in a pre-populated collection. If no collection is present, one is created and the record is read from the collection. False: Reads the record directly from the database.

GetMaterialTypes

GetStorageLocation



Returns a StorageLocation object with its properties populated with corresponding data from the material database, based on the StorageLocationID.

Syntax

Set object = MaterialSvr.GetStorageLocationByID(ByVal IStorageLocationID As Long)

The GetStorageLocationByID method syntax has these parts:

Part Description

object Reference to a valid StorageLocation object.


IStorageLocationID Represents the ID of the StorageLocation.

Returns a list of StorageLocations in a multi-dimensioned array.

Syntax

vResult = MaterialSvr.GetStorageLocationList()

The GetStorageLocationList method syntax has these parts:

Part Description



Where vResult is:

Part Description

vResult Is a two dimensional array containing <EmptyArray> | <StorageLocationData>

StorageLocationData Array Element [0] =PKid Array Element [1] = Name Array Element [2] = Description Array Element [3] = ControllerID

GetStorageLocationByID

GetStorageLocationList



Returns a collection of 1 to N StorageLocation objects.

Syntax

Set object = MaterialSvr.GetStorageLocations()

The GetStorageLocations method syntax has these parts:

Part Description

object Reference to a valid StorageLocations collection object.


Inserts a Container record into the material database.

Syntax

MaterialSvr.InsertContainer(Container As Container)

The InsertContainer method syntax has these parts:

Part Description



Inserts a ContainerMaterial record into the material database.

Syntax

Container.InsertContainerMaterial(ContainerMaterial As ContainerMaterial)

The InsertContainerMaterial method syntax has these parts:

Part Description


ContainerMaterial An instance of a ContainerMaterial object.

GetStorageLocations

InsertContainer

InsertContainerMaterial



Inserts a ContainerProperty record into the material database.

Syntax

Container.InsertContainerProperty(ContainerProperty As ContainerProperty)

The InsertContainerProperty method syntax has these parts:

Part Description



Inserts a Container State record into the material database.

Syntax

MaterialSvr.InsertContainerState(ContainerState As ContainerState)

The InsertContainerState method syntax has these parts:

Part Description



InsertContainerProperty

InsertContainerState



Inserts a QA error correction record associated with a test specification in the material database.

Syntax

MaterailSvr.InsertErrorCorrection(ErrorCorrection As ErrorCorrection)

The InsertErrorCorrection method syntax has these parts:

Part Description



Remarks

This interface will allow for the creation of QA error corrections in the material database.

Inserts a QA error correction result record associated with a test result in the material database.

Syntax

TestResult.InsertErrorCorrectionResult(ErrorCorrectionResult As ErrorCorrectionResult)

The InsertErrorCorrectionResult method syntax has these parts:

Part Description

TestResult Instance of the TestResult interface to which the method is directed.

ErrorCorrectionResult An instance of an ErrorCorrectionResult object.

Remarks

This interface allows for the creation of an error correction result on a particular test result that ended in a failure.

InsertErrorCorrection

InsertErrorCorrectionResult



Inserts a QA test specification limit record associated with a base test specification in the material database.

Syntax

TestSpecification.InsertLimit(TestSpecificationLimit As TestSpecificationLimit)

The InsertLimit method syntax has these parts:

Part Description



Remarks

This new interface will allow for the insertion of QA test specification limits to be associated with a test specification. The requirements state that a test specification can be comprised of any number of material properties. Having limit sections allows for a one-to-many relationship.

Inserts a Lot record into the material database.

Syntax

Material.InsertLot(Lot As Lot)

The InsertLot method syntax has these parts:

Part Description

Material Instance of a Material object to which the method is directed.


InsertLimit

InsertLot



Inserts a Lot State record into the material database.

Syntax

MaterialSvr.InsertLotState(LotState As LotState)

The InsertLotState method syntax has these parts:

Part Description



Inserts a Material record into the material database.

Syntax

MaterialSvr.InsertMaterial(Material As Material)

The InsertMaterial method syntax has these parts:

Part Description



InsertLotState

InsertMaterial



Inserts a MaterialClass record into the material database.

Syntax

MaterialSvr.InsertMaterialClass(MaterialClass As MaterialClass)

The InsertMaterialClass method syntax has these parts:

Part Description


MaterialClass An instance of a MaterialClass object.

Inserts a MaterialClassProperty record into the material database.

Syntax

MaterialClass.InsertMaterialClassProperty(MaterialClassProperty As MaterialClassProperty)

The InsertMaterialClassProperty method syntax has these parts:

Part Description

MaterialClass An instance of the MaterialClass object to which the method is directed.


Remarks

This allows the adding of MaterialClassProperties. The process is actually adding a record to the material database and associating the MaterialClassProperty to the MaterialClass via a foreign key in the MaterialClassProperty table.

InsertMaterialClass

InsertMaterialClassProperty



Inserts a MaterialProperty record into the material database.

Syntax

Material.InsertMaterialProperty(MaterialProperty As MaterialProperty)

The InsertMaterialProperty method syntax has these parts:

Part Description

Material Instance of the Material Interface to which the method is directed.


Remarks

When inserting a Material Property record, the Material Server will add an accompanying Lot Property for every Lot that is derived from the specified Material.

Inserts a Material Type record into the material database.

Syntax

MaterialSvr.InsertMaterialType(MaterialType As MaterialType)

The InsertMaterialType method syntax has these parts:

Part Description



InsertMaterialProperty

InsertMaterialType



Inserts a StorageLocation record into the material database.

Syntax

MaterialSvr.InsertStorageLocation(StorageLocation As StorageLocation)

The InsertStorageLocation method syntax has these parts:

Part Description



Inserts a SubLot record into the material database.

Syntax

Container.InsertSubLot(SubLot As SubLot)

The InsertSubLot method syntax has these parts:

Part Description



InsertStorageLocation

InsertSubLot



Inserts a QA test specification record into the material database.

Syntax

Material.InsertTestSpecification(TestSpecfication As TestSpecification)

The InsertTestSpecification method syntax has these parts:

Part Description


TestSpecification An instance of a TestSpecification object.

Remarks

This interface allows for the creation of QA test specification records in the material database. The interface is part of the material object. This placement allows for multiple test specifications to be created for any given material. It also allows for the inclusion of multiple material properties to be part of a test specification.

Returns a Boolean value (TRUE or FALSE) indicating if the current user has rights to the Batch Server security role.

Syntax

bResult = MaterialServerSecurity.IsBatchServer()

The IsBatchServer method syntax has these parts:

Part Description

bResult Boolean value that returns TRUE or FALSE which represents if the current user has access to interfaces defined for use for the BatchServer Role.

MaterialServerSecurity Instance of the MaterialServerSecurity Interface to which the method is directed.

InsertTestSpecification

IsBatchServer



Returns a Boolean value (TRUE or FALSE) indicating if the current user has rights to the Lot Author security role.

Syntax:

bResult = MaterialServerSecurity.IsLotAuthor()

The IsLotAuthor method syntax has these parts:

Part Description

bResult Boolean value that returns TRUE or FALSE which represents if the current user has access to interfaces defined for use for the LotAuthor Role.


Returns a Boolean value (TRUE or FALSE) indicating if the current user has rights to the Material Author security role.

Syntax

bResult = MaterialServerSecurity.IsMaterialAuthor()

The IsMaterialAuthor method syntax has these parts:

Part Description

bResult Boolean value that returns TRUE or FALSE which represents if the current user has access to interfaces defined for use for the MaterialAuthor Role.


IsLotAuthor

IsMaterialAuthor



Returns a Boolean value (TRUE or FALSE) indicating if there is communications to the Material Server.

Syntax

bResult = MaterialServerUtils.IsMaterialServerAvailable()

The IsMaterialServerAvailable method syntax has these parts:

Part Description

bResult Boolean value that returns TRUE or FALSE which represents if the server successfully initialized all connection points.

MaterialServerUtils Instance of the MaterialServerUtils Interface to which the method is directed.

Returns a Boolean value (TRUE or FALSE) indicating if the current user has rights to the Material Viewer security role.

Syntax

bResult = MaterialServerSecurity.IsMaterialViewer()

The IsMaterialViewer method syntax has these parts:

Part Description

bResult Boolean value that returns TRUE or FALSE which represents if the current user has access to interfaces defined for use for the MaterialViewer Role.


IsMaterialServerAvailable

IsMaterialViewer



Maps a MaterialClassProperty record to the material definition in the material database.

Syntax

Material.MapMaterialClassProperty(MaterialClassProperty As MaterialClassProperty)

The MapMaterialClassProperty method syntax has these parts:

Part Description



Remarks

This interface allows the mapping of MaterialClassProperties to the material definition.

Returns a collection of MaterialClassProperty objects that are derived from the material class upon which they are based.

Syntax

MaterialClass.MaterialClassProperties

The MaterialClassProperties property syntax has these parts:

Part Description

MaterialClass Instance of the MaterialClass interface to which the method is directed.

Remarks

The MaterialClass object contains a new property, called MaterialClassProperties, that will present a collection of MaterialClassProperty objects derived from the MaterialClass. This functionality is consistent with how the existing material object model presents collections that are based on a parent object. For example, the material object has a property called MaterialProperties that presents a collection of MaterialProperties that are derived from the represented Material.

MapMaterialClassProperty

MaterialClassProperties



Updates a Container record in the material database.

Syntax

MaterialSvr.UpdateContainer(Container As Container, [ActivityDescription As String])

The UpdateContainer method syntax has these parts:

Part Description




Updates a ContainerPriority record in the material database.

Syntax

MaterialSvr.UpdateContainerPriority(ContainerPriority As ContainerPriority)

The UpdateContainerPriority method syntax has these parts:

Part Description


ContainerPriority An instance of a ContainerPriority object.

Remarks

The only property that can be updated in the ContainerPriority object is the ‘Priority’.

UpdateContainer

UpdateContainerPriority



Updates a ContainerProperty record in the material database.

Syntax

Container.UpdateContainerProperty(ContainerProperty As ContainerProperty, [ActivityDescription As String])

The UpdateContainerProperty method syntax has these parts:

Part Description




Updates a ContainerState record in the material database.

Syntax

MaterialSvr.UpdateContainerState(ContainerState As ContainerState)

The UpdateContainerState method syntax has these parts:

Part Description



Remarks:

The ‘Ready To Use’ ContainerState is a system-defined state and cannot be deleted through this interface or by any other means.

UpdateContainerProperty

UpdateContainerState



Updates a QA error correction record associated with a test specification in the material database.

Syntax

MaterialSvr.UpdateErrorCorrection(ErrorCorrection As ErrorCorrection)

The UpdateErrorCorrection method syntax has these parts:

Part Description



Remarks

This interface will allow for the modification of QA error correction records in the material database.

Updates a QA error correction result record associated with a test result in the material database.

Syntax

TestResult.UpdateErrorCorrectionResult(ErrorCorrectionResult As ErrorCorrectionResult)

The UpdateErrorCorrectionResult method syntax has these parts:

Part Description

TestResult Instance of the TestResult interface to which the method is directed.

ErrorCorrectionResult An instance of an ErrorCorrectionResult object.

Remarks

This interface allows for the updating of an error correction result on a particular test result that ended in a failure.

UpdateErrorCorrection

UpdateErrorCorrection Result



Updates a QA test specification limit record associated with a base test specification in the material database.

Syntax

TestSpecification.UpdateLimit(TestSpecjficationLimit As TestSpecificationLimit)

The UpdateLimit method syntax has these parts:

Part Description



Remarks

This interface will allow for the modification of a QA test specification detail record after it has been added to the material database.

Updates a Lot record in the material database.

Syntax

Material.UpdateLot(Lot As Lot, [ActivityDescription As String])

The UpdateLot method syntax has these parts:

Part Description




UpdateLimit

UpdateLot



Updates a LotProperty record in the material database.

Syntax

Lot.UpdateLotProperty(LotProperty As LotProperty, [ActivityDescription As String])

The UpdateLotProperty method syntax has these parts:

Part Description

Lot Instance of the Lot object to which the method is directed.

LotProperty An instance of a LotProperty object.


Updates a LotState record in the material database.

Syntax

MaterialSvr.UpdateLotState(LotState As LotState)

The UpdateLotState method syntax has these parts:

Part Description



Remarks

The ‘Ready To Use’ LotState is a system-defined state and can not be updated via this method or any other means.

UpdateLotProperty

UpdateLotState



Updates a Material record in the material database.

Syntax

MaterialSvr.UpdateMaterial(Material As Material, [ActivityDescription As String])

The UpdateMaterial method syntax has these parts:

Part Description




Updates a Class record in the material database.

Syntax

MaterialSvr.UpdateMaterialClass(MaterialClass As MaterialClass)

The UpdateMaterialClass method syntax has these parts:

Part Description


MaterialClass An instance of a MaterialClassGroup object.

UpdateMaterial

UpdateMaterialClass



Updates a MaterialClassProperty record in the material database.

Syntax

MaterialClass.UpdateMaterialClassProperty(MaterialClassProperty As MaterialClassProperty), PropagateChanges As Boolean, [ActivityDescription As String])

The UpdateMaterialClassProperty method syntax has these parts:

Part Description

MaterialClass Instance of the MaterialClass public interface to which the method is directed.



Updates a MaterialProperty record in the material database.

Syntax

Material.UpdateMaterialProperty(MaterialProperty As MaterialProperty, [ActivityDescription As String])

The UpdateMaterialProperty method syntax has these parts:

Part Description




UpdateMaterialClass Property

UpdateMaterialProperty



Updates a MaterialType record in the material database.

Syntax

MaterialSvr.UpdateMaterialType(MaterialType As MaterialType)

The UpdateMaterialType method syntax has these parts:

Part Description



Remarks

The ‘Ungrouped’ MaterialType is a system-defined state which cannot be deleted through this interface or by any other means.

Updates a StorageLocation record in the material database.

Syntax

MaterialSvr.UpdateStorageLocation(StorageLocation As StorageLocation)

The UpdateStorageLocation method syntax has these parts:

Part Description



UpdateMaterialType

UpdateStorageLocation



Updates a SubLot record in the material database.

Syntax

Lot.UpdateSubLot(SubLot As SubLot, [ActivityDescription As String])

The UpdateSubLot method syntax has these parts:

Part Description

Lot Instance of the Lot object to which the method is directed.



Updates a QA test result record associated with a test specification in the material database.

Syntax

TestSpecification.UpdateTestResult(TestResult As TestResult)

The UpdateTestResult method syntax has these parts:

Part Description

TestSpecification Instance of the TestSpecification interface to which the method is directed.


Remarks

This interface allows for the modification of QA test result records in the material database.

UpdateSubLot

UpdateTestResult



Updates a QA test specification record in the material database.

Syntax

Material.UpdateTestSpecification(TestSpecification As TestSpecification)

The UpdateTestSpecification method syntax has these parts:

Part Description


TestSpecification An instance of a TestSpecification object.

Remarks

This interface will allow for the modification of a QA test specification after it is added to the material database.

UpdateTestSpecification


Legal Notices

Copyright notice





Trademark Notices




Legal Notices



Legal Notices


Warranty












C CreateTestResult 15

D DeleteContainer 16, 17 DeleteContainerProperty 17 DeleteErrorCorrection 18 DeleteLimit 19 DeleteLot 19 DeleteLotProperty 20 DeleteLotState 20 DeleteMaterial 21 DeleteMaterialClass 21 DeleteMaterialClassProperty 22 DeleteMaterialType 23 DeleteSubLot 24 DeleteTestResult 24 DeleteTestSpecification 25 DistributeSubLot 25

G GetContainer 26 GetContainerByID 27 GetContainerList 28 GetContainerOrStorageLocationMaterials 29 GetContainerPriorityListByMaterial 30 GetContainerPropertyListByContainer 29 GetContainers 27 GetContainersHavingMaterial 30 GetContainerState 31 GetContainerStateList 32 GetContainerStates 32 GetErrorCorrection 33 GetErrorCorrections 34 GetLot 34 GetLotList 35 GetLots 36 GetLotState 36 GetLotStateList 37 GetLotStates 37 GetMaterial 38 GetMaterialByControllerID 39 GetMaterialByID 39

GetMaterialClass 40 GetMaterialClassByID 40 GetMaterialClasses 41 GetMaterialClassList 41 GetMaterialList 42 GetMaterials 43 GetMaterialType 44 GetMaterialTypeByID 44 GetMaterialTypeList 45 GetMaterialTypes 46 GetStorageLocation 46 GetStorageLocationByID 47 GetStorageLocationList 47 GetStorageLocations 48

I InsertContainer 48 InsertContainerMaterial 48 InsertContainerProperty 49 InsertContainerState 49 InsertErrorCorrection 50 InsertErrorCorrectionResult 50 InsertLimit 51 InsertLot 51 InsertLotState 52 InsertMaterial 52 InsertMaterialClass 53 InsertMaterialClassProperty 53 InsertMaterialProperty 54 InsertMaterialType 54 InsertStorageLocation 55 InsertSubLot 55 InsertTestSpecification 56 IsBatchServer 56 IsLotAuthor 57 IsMaterialAuthor 57 IsMaterialServerAvailable 58 IsMaterialViewer 58

M MapMaterialClassProperty 59 Material Object Model

diagram 8 objects 9

Index

Index


MaterialClassProperties 59 Methods

Count 9 Item 9 NewEnum 9

O Objects

Container 9 ContainerMaterial 9 ContainerProperty 9 ContainerState 9 Lot 9 LotProperty 9 LotState 9 Material 9 MaterialClass 9 MaterialClass group 9 MaterialProperty 9 MaterialSVR 9 MaterialType 9 StorageLocation 9 SubLot 9

U UpdateContainer 60 UpdateContainerPriority 60 UpdateContainerProperty 61 UpdateContainerState 61 UpdateErrorCorrection 62 UpdateErrorCorrectionResult 62 UpdateLimit 63 UpdateLot 63 UpdateLotProperty 64 UpdateLotState 64 UpdateMaterial 65 UpdateMaterialClass 65 UpdateMaterialClassProperty 66 UpdateMaterialProperty 66 UpdateMaterialType 67 UpdateStorageLocation 67 UpdateSubLot 68 UpdateTestResult 68 UpdateTestSpecification 69

Rockwell Automation Publication BWMTR-UM011D-EN-P - February 2017

Supersedes BWMTR-UM011C-EN-P - November 2014 Copyright © 2017 Rockwell Automation Technologies, Inc. All rights reserved. Printed in the U.S.A.

Rockwell Automation support

Rockwell Automation provides technical information on the web to assist you in using its products. At http://www.rockwellautomation.com/support you can find technical and application notes, sample code, and links to software service packs. You can also visit our Support Center at https://rockwellautomation.custhelp.com for software updates, support chats and forums, technical information, FAQs, and to sign up for product notification updates.

In addition, we offer multiple support programs for installation, configuration, and troubleshooting. For more information, contact your local distributor or Rockwell Automation representative, or visit http://www.rockwellautomation.com/services/online-phone.

Installation assistance

If you experience a problem within the first 24 hours of installation, review the information that is contained in this manual. You can contact Customer Support for initial help in getting your product up and running.

United States or Canada 1.440.646.3434

Outside United States or Canada Use the Worldwide Locator available at http://www.rockwellautomation.com/locations, or contact your local Rockwell Automation representative.

New product satisfaction return

Rockwell Automation tests all of its products to ensure that they are fully operational when shipped from the manufacturing facility. However, if your product is not functioning and needs to be returned, follow these procedures.

United States Contact your distributor. You must provide a Customer Support case number (call the phone number above to obtain one) to your distributor to complete the return process.

Outside United States Please contact your local Rockwell Automation representative for the return procedure.

Documentation feedback

Your comments will help us serve your documentation needs better. If you have any suggestions on how to improve this document, complete the feedback form, publication RA-DU002.

http://www.rockwellautomation.com/support

https://rockwellautomation.custhelp.com/

http://www.rockwellautomation.com/services/online-phone

http://www.rockwellautomation.com/locations

http://literature.rockwellautomation.com/idc/groups/literature/documents/du/ra-du002_-en-e.pdf

factorytalk® batch material manager - rockwell automation · rockwell automation publication...

Documents