Transcription

Application Code ManagerUser ManualUser ManualOriginal Instructions

Application Code Manager User ManualImportant User InformationRead this document and the documents listed in the additional resources section about installation, configuration, andoperation of this equipment before you install, configure, operate, or maintain this product. Users are required to familiarizethemselves with installation and wiring instructions in addition to requirements of all applicable codes, laws, and standards.Activities including installation, adjustments, putting into service, use, assembly, disassembly, and maintenance are required tobe carried out by suitably trained personnel in accordance with applicable code of practice.If this equipment is used in a manner not specified by the manufacturer, the protection provided by the equipment may beimpaired.In no event will Rockwell Automation, Inc. be responsible or liable for indirect or consequential damages resulting from the useor application of this equipment.The examples and diagrams in this manual are included solely for illustrative purposes. Because of the many variables andrequirements associated with any particular installation, Rockwell Automation, Inc. cannot assume responsibility or liability foractual 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 softwaredescribed in this manual.Reproduction of the contents of this manual, in whole or in part, without written permission of Rockwell Automation, Inc., isprohibited.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 personalinjury 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.IMPORTANT Identifies information that is critical for successful application and understanding of the product.Labels may also be on or inside the equipment to provide specific precautions.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.ARC FLASH HAZARD: Labels may be on or inside the equipment, for example, a motor control center, to alert people to potential Arc Flash. Arc Flash willcause severe injury or death. Wear proper Personal Protective Equipment (PPE). Follow ALL Regulatory requirements for safe work practices and forPersonal Protective Equipment (PPE).2Rockwell Automation Publication LOGIX-UM003G-EN-P-December 2020

Table of ContentsApplication Code ManagerConnect to an ACM databaseProject DevelopmentRegistered LibrariesChapter 1Application Code Manager Overview . 7Design process . 8Library objects . 11Templates. 12Schedules . 13Design Automation Concept . 13Create a central ACM database . 13Upgrading a central ACM database . 15Initial configuration of Application Code Manager . 15Upgrade the Application Code Manager application . 16Navigate the Application Code Manager user interface . 17Chapter 2Connect to an ACM database . 21Connection Properties settings . 22Advanced Properties settings .23Chapter 3Project Development . 27Project commands . 27Create a new project . 28Create a new project from an existing project . 29Add a Historian object . 29Add a Historian sub-object . 30Historian Point Type parameters . 31Generate a Historian object .32Add an HMI object . 33Add a Display sub-object . 34HMI Display parameters . 34Generate an HMI object . 35Add an Alarm Group sub-object .36FTAE Alarm Group parameters. 37Find an object . 37Update a project library . 37Extract attached files . 38Indications .39Chapter 4Registered Libraries. 41Register an ACM library object . 42Rockwell Automation Publication LOGIX-UM003G-EN-P-December 20203

Table of ContentsReconstitute an ACD file . 42View registered library usage . 43Share libraries, templates, and schedules .44Local library and template file location .45Library Repositories .45Configure controllersUse ACM Tools4Chapter 5Configure controllers .47Generate a controller file . 48Add a new controller . 49Move or copy a controller to another project . 49Select Destination Project dialog box . 50Add a controller from an ACD or L5X file. 51Update using an ACD or L5X file . 51Detach from ACD/L5X files . 53Contribute instances . 53Merge controllers . 53Add a hardware module .54Delete a hardware module .54Use Copy and Paste Special . 55Add a new instance .56Add a new software object to a controller .56Generate a partial program . 57Generate a partial routine . 58Object Configuration Wizard . 58Auto Create Linked Objects .59Chapter 6Use ACM Tools . 61Import Export Manager . 61Import a schedule .63Import Export Manager Import tab settings . 64Export a schedule . 64Import Export Manager Export tab settings . 66Compare a project to a saved schedule . 66Import Export Manager Compare Tab settings .67Update controller parameters with the related tag values .67Import Export Manager Tags Import tab settings. 68Generate a Tag Configurator workbook . 68Import Export Manager Tags Export tab settings . 69Create an ACM partial import file . 69Import Export Manager IAB/Architect tab settings . 70Rockwell Automation Publication LOGIX-UM003G-EN-P-December 2020

Table of ContentsCreate a new schedule template . 70Database Manager . 73Create an ACM database . 73Upgrade an ACM database .74Backup an ACM database . 75Restore an ACM database. 75Delete an ACM database. 77Database Manager settings . 77Log Debug Information . 78Log File Viewer .79ACM Default Settings .79Document Template Editor. 80Components on the Document Template Editor . 81Menu bar. 82Tool bar . 84Output panel . 86Editor pane . 86Supported instructions . 87Types datasets .93Technical view of looping statements .95Getting to know the ACM database structure .97Working with SQL Queries in Document Generation Scripts . 103Add ACM library content to an existing ACD project . 107ReportsACM ConsoleLegal NoticesChapter 7Reports . 109Report command reference. 110Generate a report . 111Chapter 8ACM Console .113Open the ACM Console . 114List all commands . 115Generate a limited list of commands . 115Generate detailed command information . 115Console scripts . 116Create an Application Code Manager Console script . 116Run an Application Code Manager Console script . 116Extended scripts .117Legal Notices . 123Rockwell Automation Publication LOGIX-UM003G-EN-P-December 20205

Chapter 1Application Code ManagerApplication Code ManagerOverviewStudio 5000 Application Code Manager is a tool that enables more efficientproject development with libraries of reusable code. Application CodeManager creates modular objects with customizable configurationparameters using the reusable content. Application Code Manager can alsocreate the associated visualization, historical and alarming elements for aproject.Use Application Code Manager to: Create databasesRegister librariesCreate projectsManage objectsApplication Code Manager includes an additional command-line tool, theACM Console. Use the ACM Console to perform the following actions: Edit ParametersExport All ProjectsExport Libraries by AttributeGenerate Controller (as an L5X or ACD file)Import ProjectPublish LibraryBefore starting a project, become familiar with the basic concepts used inApplication Code Manager; the design process, the different library objects,the available templates, the use of schedules, and the design outputs fromApplication Code Manager.ActivationActivating Application Code Manager provides access to all Application CodeManager features.When not activated Application Code Manager has the following limitations: Application Code Manager can only connect to a local databaseinstance. Application Code Manager can only support a single controller perproject. Attempting to import projects with multiple controllers willresult in an error.Rockwell Automation Publication LOGIX-UM003G-EN-P-December 20207

Chapter 1Application Code ManagerSee alsoDesign process on page 8Library objects on page 11Templates on page 12Schedules on page 13Initial configuration of Application Code Manager on page 15Design processThe Application Code Manager (ACM) design process introduces a modular,object-based approach to the creation of ACD controller code, FactoryTalk View SE/ME display content, FactoryTalk Historian Tag and Alarms importconfiguration.The Studio 5000 ACM design process separates function and configurationinto two separate layers of data, and divides the design process into twodistinct workflows, library management and project execution.The design process involves a suite of applications: The Studio 5000 Logix Designer applicationThe Library DesignerThe Library Object Manager applicationThe Application Code Manager applicationFactoryTalk View StudioLibrary management workflow: Studio 5000 Logix DesignerThe library management workflow begins when a specific instance of ACDcontroller code is created in the Logix Designer application. The specificinstance is a single project containing a single controller. The project includesa logical structure containing these Logix objects: Controller TagsTasksMotion GroupsAdd-On InstructionsData TypesTrendsI/O ConfigurationsEach Logix object has an internal hierarchy of elements. Example: a task maycontain one or more programs, each of which may contain one or moreroutines.Every project has one controller. There may be one, many, or no instances ofany type of Logix object in the project when the specific instance is created.This single instance of controller code is saved to an ACD file.8Rockwell Automation Publication LOGIX-UM003G-EN-P-December 2020

Chapter 1Application Code ManagerTraditionally, controller code was designed and configured for a specificproject. In the library management workflow, content is not designed for aspecific project, but to provide a widely applicable set of functions known asproject components that are then used to create library objects. Each libraryobject is an independent functional entity that can be easily configured tomeet a wide range of applications and can be used in many projects.Library DesignerUse the Library Designer to assign the project, the controller, and any of theLogix objects to one or many library objects. Each library object defines a setof functions, capabilities, and connections. Example: those that supportfunction of the valve, motor, and controller modules. Rather than being tied toone application, library objects can be configured to meet the needs ofmultiple applications. The Library Designer allows the publishing of a librarydirectly into an ACM database. Options include the ability to specify thelocation where the library will be published in the ACM database, and theability to specify the status of the library, either Published or Pending.Custom properties called "Decorations" can be added to a library object usingthe Library Designer. Decorations include parameters, sub-objects, functions,substitutions, and external references. Decoration lets the library object beconfigured when it is implemented in a project in the ACM application.Logix objects can be restricted to a single library object or assigned to multiplelibrary objects, each with a different set of decorations. A library object cancontain a single Logix object, or a Logix object can be added as an element of amore complex library object. Example: a P Alarm Add-On Instruction can beassigned to a valve library object and can also be an element of a Motor orPump library object.Each ACD file can support multiple projects, controller libraries, and libraryobjects. The ACD is not required to contain a project or controller library.While decoration is stored as part of the ACD file, it is treated as a separatelayer of information from the base controller code and does not affect codeexecution.Decoration controls how the library object is instantiated, includingconfigurations such as naming, tag values, conditional inclusion, andconnections to other library objects. One or many distinct instances of alibrary object can be instantiated within an ACM project and each instancecan be separately configured. Using Library Designer each Logix object can bepublished directly to the ACM database or to a file in HSL4 format.Rockwell Automation Publication LOGIX-UM003G-EN-P-December 20209

Chapter 1Application Code ManagerLibrary Object ManagerThe library management workflow continues by opening the decorated ACDfile in the Library Object Manager application. The Library Object Managerapplication can be used to publish each library object, either directly to theACM database or to a file in HSL4 format. HSL4 files can be distributedindividually or as part of a repository.Use Library Object Manager to add HMI displays (FactoryTalk View SE/ME),FactoryTalk Alarms and Events configurations, FactoryTalk View ME Alarmsand Historian (FactoryTalk Historian SE) components to the library object.This can only be done after the library object has bee