1. Agentry App DevelopmentSAP Mobile Platform 3.0

2. DOCUMENT ID: DC-01-0300-01 LAST REVISED: November 2013 Copyright 2013 by SAP AG or an SAP affiliate company. All rights reserved. No part of this publication may be reproduced or transmitted in any form or for any purpose without the express permission of SAP AG. The information contained herein may be changed without prior notice. Some software products marketed by SAP AG and its distributors contain proprietary software components of other software vendors. National product specifications may vary. These materials are provided by SAP AG and its affiliated companies ("SAP Group") for informational purposes only, without representation or warranty of any kind, and SAP Group shall not be liable for errors or omissions with respect to the materials. The only warranties for SAP Group products and services are those that are set forth in the express warranty statements accompanying such products and services, if any. Nothing herein should be construed as constituting an additional warranty. SAP and other SAP products and services mentioned herein as well as their respective logos are trademarks or registered trademarks of SAP AG in Germany and other countries. Please see http://www.sap.com/corporate-en/legal/copyright/ index.epx#trademark for additional trademark information and notices. 3. Contents Agentry App Development ....................................................1 Setting Up the Development Environment - Agentry Toolkit .........................................................................1 Installing the Agentry Editor Plug-In and Eclipse Platform .............................................................4 Agentry Editor and Eclipse Platform Configuration Overview ...................................11 Agentry OpenUI SDK for iOS Setup Overview ....33 Agentry OpenUI SDK for Android Setup Overview .........................................................36 Agentry OpenUI for Windows Setup Information .........................................................................42 Installing the Agentry Test Environment ..............42 Agentry SAP Framework Foundation Installation Overview .........................................................44 Installing the Agentry SDK ...................................52 Developing Agentry Apps .............................................53 Eclipse Preferences for the Agentry Editor PlugIn .....................................................................53 Agentry Editor and Eclipse Platform Overview ....57 Agentry Application Projects: Creating, Managing, and Publishing ...............................75 Overview of Mobile Northwind Sample Application .....................................................138 Target Paths and the Property Browser .............139 Rules: An Introduction .......................................171 Rule Context ......................................................175 Rule Data Types ................................................176 Rule Editor Introduction .....................................179 Syclo Data Markup Language ...........................189 SDML Syntax and Data Tag Expansion .............190Agentry App Developmentiii 4. ContentsAgentry Data Definitions Overview ....................194 Data Synchronization Overview: The Exchange Data Model ....................................................195 Data Synchronization: Data Filtering Overview . 197 Object Development Concepts and Considerations ..............................................198 Agentry User Interface Definitions Overview .....213 Client User Interface Considerations and Guidance .......................................................218 Security Related Development Overview ..........219 Attached Documents and File Transfer: Key Concepts .......................................................226 The Agentry SDK ...............................................249 Agentry Language Reference .....................................275 Application Level Definitions Overview ..............275 Module-Level Data Definitions Overview ...........312 Module-Level User Interface Definitions Overview .......................................................379 Rule Function Terms Overview ..........................458 Syclo Data Markup Language ...........................537 Agentry Test Script Overview ............................586 Agentry Java API ...............................................647 Agentry SAP Framework ............................................811 Agentry SAP Framework ...................................811 Agentry Device Client Branding SDK .........................989 Agentry Client Installer and Executable Branding ........................................................989 Agentry OpenUI API ...................................................993 Agentry Client OpenUI API Overview ................993 Agentry OpenUI API for Android ........................996 Agentry OpenUI API for iOS ............................1133 Agentry OpenUI API for WPF ..........................1200 Index ..............................................................................1259ivSAP Mobile Platform 5. Agentry App DevelopmentAgentry App DevelopmentSetting Up the Development Environment - Agentry Toolkit Included within the SAP Mobile Platform SDK are components for Agentry development, which make up the Agentry Toolkit. These components are intended for developers, implementors, and administrators. With the exception of the Agentry SAP Framework Foundation, all the components described here can be found in the SAP Mobile Platform SDK. This SDK is available on the SAP Service Marketplace. After extracting archive that contains all tools available for the SAP Mobile Platform SDK, there are several different items available in various folders. For those components relative to Agentry development, this includes the installers and resources discussed here, as well as the Agentry Client installers. The Agentry SAP Framework Foundation is an ABAP add-on installed to the SAP system to which the mobile application is to connect and with which it will synchronize data. Since this component is not installed to the same system as the other components of the Agentry development tools, but instead to the SAP system, it is provided as a separate download within the list of SAP Mobile Platform components on the SAP Service Marketplace website. Each of these components is described briefly below and includes the location of the component with a path relative to the location where the SAP Mobile SDK archive was extracted. Agentry Editor File locations: 32 bit build: AgentryToolkit32-bitAgentryEditor Agentry_7.0.x.x_EditorPlugin_x86.zip 64 bit build: AgentryToolkit64-bitAgentryEditor Agentry_7.0.x.x_EditorPlugin_x86_64.zipThe Agentry Editor is the primary development tool for mobile applications built using the Agentry archetype within the SAP Mobile Platform. This is provided as a plug-in to the Eclipse IDE. The proper version of Eclipse must be installed and configured first, followed by the installation of the plug-in to the Eclipse implementation. The Agentry Editor provides a point and click development environment, within which the mobile application can be built or an existing mobile application can be modified for specific implementation needs.Agentry App Development1 6. Agentry App DevelopmentAgentry OpenUI SDK & Android and iOS Agentry Client Rebranding File locations: Agentry OpenUI SDK for Android: AgentryToolkitAgentryOpenUISDK SMPAgentryClientFramework-Android-7.0.x.x.zip Agentry OpenUI SDK for iOS: AgentryToolkitAgentryOpenUISDK SMPAgentryClientFramework-iOS-7.0.x.x.tgz Agentry OpenUI SDK for Windows - Sample Project Only: AgentryToolkit AgentryOpenUISDKAgentry_7.0.x.x_OpenUISampleDotNET.zipThe Agentry OpenUI SDK is introduced in the SAP Mobile Platform SDK 3.0 release. This SDK is available for Android, iOS, and Windows client platforms. It is provided to allow developers to create custom controls for the Agentry Client. These custom controls will then override the standard field edit types within the Agentry Client at runtime. For both Android and iOS the client framework archives listed above provide the needed resources to develop custom controls using the OpenUI SDK. For the Agentry Client for Windows devices, this is not necessary. Rather, a project is created in Visual Studio targeting .NET 4.5 Framework, and which uses reflection to obtain information about the loaded assemblies for the OpenUI interface. Additionally, the resources provided in these same SDK files also provide the necessary interface to support rebranding of the Agentry Client for Android and iOS. Windows clients are rebranded using the Agentry Device Client Branding SDK, as in previous versions of SAP Mobile Platform and/or Agentry Mobile Platform. Agentry Test Environment File location: Installer: AgentryToolkitAgentryTestEnvironment Agentry_7.0.x.x_Test_Environment.exeThe Agentry Test Environment provides an Agentry Client which runs within a test and monitoring interface. This interface provides tools to inspect data stored on the client device, including objects, transactions, complex tables, and data tables. Actions and transactions can be debugged as they are executed or instantiated. Client devices hardware features including barcode scanners and GPS units can be mimicked within the Agentry Test Environment to support full functional testing of client-side behavior of the mobile application. The Agentry Test Environment can also mimic various client device types and form factors. Agentry Java API File location: Agentry Java API: AgentryToolkitAJAPIAgentry-v5.jar Agentry Java API Javadoc: AgentryToolkitAJAPIAgentry-v5-doc.zipThe Agentry Java API is provided for development of mobile applications with a Java system connection. This API provides the interface between the Agentry Server and the Java2SAP Mobile Platform 7. Agentry App Development synchronization logic. This interface supports passing data between this logic and the Agentry Server, and also provides state, user, and other runtime information. Base classes for step definition logic, complex table and data table synchronization logic are included within the API and are extended by the logic written specific to the mobile application. The Agentry Java API is contained in a single Jar file, named Agentry-v5.jar. Also included is a ZIP archive containing the associated Javadoc content, which can be referenced as a resource within the Eclipse Java project. Details on creating a Java project in Eclipse, including how to add the associated documentation, are provided in a later procedure. Agentry Branding SDK File location: Windows CE Client Branding SDK: AgentryToolKitBrandingSDK Agentry_ClientWinCE_Branding.exe iOS and Android: This functionality is encompassed by the OpenUI and the associatedAgentry client framework resources provided as a part of the OpenUI SDK. Creating the projects as instructed for each of these will also provide the necessary framework to rebrand these clients. Windows WPF and Windows Desktop: The Branding SDK is provided from the standard client installers for each these, with special command line switches provided during execution. See the instructions provided for details.Rebranding the Agentry Client for Windows devices begins with the installation of the needed rebranding resources. For the Windows desktop Agentry Client builds, this is provided by running the Agentry Client installer with specified command line arguments. This may either be the Agentry Client installer for Windows 7 desktop or earlier, or the .NET Windows Client installer for Windows 8 desktops and tablets. Rebranding of the Agentry Client for Windows mobile devices begins with the installation of the Agentry Branding SDK, which provides the necessary resources to rebrand and then package the Agentry Client executable for you application. Rebranding the Agentry Client for both Android and iOS devices is accomplished within the framework provided by the OpenUI SDK. Icon images and UI text can be overridden within the framework and the Agentry Client rebuilt to include these branded resources using the framework provided as a part of the OpenUI SDK for these two platforms. Agentry SAP Framework Foundation and Related Resources Note: This component is not provided in the SAP Mobile Platform SDK. It is an ABAP AddOn and is installed only to SAP Systems and is available on the SAP Service Marketplace. The Agentry SAP Framework Foundation is an ABAP Add-On that is installed to the SAP system with which the mobile application is to connect and synchronize. This component is only used for SAP systems; other back end systems will not use this component. The Agentry SAP Framework Foundation provides the framework within which the needed synchronization support for the mobile application is implemented. This includes exchangeAgentry App Development3 8. Agentry App Development data model components such as triggers, mobile data objects, rules, filters, and other similar pieces. This component of the SAP Mobile Platform is provided on SAP Service Marketplace as an available download. However, if the intention of your installation is to deploy a packaged mobile application built on Agentry, this component should not be installed. Rather, the Agentry SAP Framework ABAP Add-On provided with that application, which will include application-specific components, should instead be installed. The Agentry SAP Framework Foundation is provided for user cases in which a new mobile application for an existing SAP system is being developed form the ground up. Agentry SDK The Agentry SDK installer is provided for two development scenarios. The first is when it is desired to develop ActiveX controls for use on Windows Mobile devices. The second is when it is necessary to develop interprocess communications between the Agentry Client and another process running on the mobile device. If neither of these scenarios are applicable to your environment, this component need not be installed. If the Agentry SDK is to be installed and used, see the installation procedure provided in the SAP Mobile SDK installation guide, as well as the information on the structure and usage of the APIs within this SDK provided in the Developer Guide: Agentry Applications.Installing the Agentry Editor Plug-In and Eclipse Platform Prerequisites The following items must be addressed prior to installing the Agentry Editor Eclipse plugin: Determine if the proper installation for both Eclipse and the Agentry Editor plug-in is the 32-bit or 64-bit build. The SAP Mobile SDK 3.0 must have already been installed and access to the items installed by it must be available. Obtain the proper ZIP archive of Eclipse from one of the following two locations: 32-Bit Build: Click Here for Eclipse 32-Bit Download or enter the following URL in a web browser: http://www.eclipse.org/downloads/download.php?file=/eclipse/ downloads/drops4/R-4.2.2-201302041200/eclipse-SDK-4.2.2win32.zip64-Bit Build: Click Here for Eclipse 64-Bit Download or enter the following URL in a web browser: http://www.eclipse.org/downloads/download.php?file=/eclipse/ downloads/drops4/R-4.2.2-201302041200/eclipse-SDK-4.2.2-win32x86_64.zip4SAP Mobile Platform 9. Agentry App Development Log into the intended host system as a user with Administrative privileges. Internet access is needed while the Agentry Editor plug-in installation is active to allow for any dependent modules to be downloaded to the Eclipse implementation.Task The Agentry Editor is provided as a plug-in to Eclipse. This procedure provides the steps necessary to first install Eclipse and then to install the Agentry Editor to this Eclipse implementation. As noted in the prerequisites, the Eclipse installer should be obtained form the eclipse.org website, with the proper 32-bit or 64-bit build downloaded from that site. Eclipse is provided in a ZIP archive which is extracted to the desired installation location. Once this is complete, the Agentry Editor plug-in can be added to the Eclipse implementation according to the instructions provided here. The build of the Agentry Editor plug-in must match the Eclipse build, and both 32-bit and 64-bit Agentry Editor builds are available. 1. The Agentry Editor Eclipse plug-in is bundled within the SAP Mobile SDK 2.3 package provided on the SAP Service Marketplace. There are two files available and the one corresponding to either a 32-bit or 64-bit installation should be used for this procedure (as listed below). Make the ZIP archive available on the system where Eclipse is to be installed: 32-Bit: Agentry_7.0.0.x_EditorPlugin_x86.zip 64-Bit: Agentry_7.0.0.x_EditorPlugin_x86_64.zip2. Navigate in a web browser to one of the two URLs provided in the prerequisites to install either the 32-bit or 64-bit build of the Eclipse platform. Installation of Eclipse involves extracting the contents of the archive to the desired installation location. No installer is run for this process. 3. Install the Java Runtime Environment for Eclipse. This can be installed to the host system using the default location for the JRE; alternately it can be installed to the same location as the Eclipse instance, in a directory named jre. For example, if Eclipse is installed to C: eclipse, the JRE can be installed to C:eclipsejre. This is the recommended location, as installing the JRE here does not require any environment variables to be modified on the Windows host system, as Eclipse looks to this location first for the JRE. If installed to a different location, the paths for the jrebin and jrelib directories of Java installation must be added to the Path environment variable in Windows before attempting to start Eclipse. 4. Start Eclipse by executing the eclipse.exe executable file found in the extracted folder. 5. During startup you are prompted to select or create an Eclipse workspace. The proper selection is based on the following: New Agentry Installation: Create a new workspace Upgrading an Agentry 5.x or earlier installation: Create a new workspaceAgentry App Development5 10. Agentry App Development Upgrading an Agentry 6.0.x installation: Either select the existing workspace or create a new one and import the projects after the Agentry Editor plug-in has been installed.6. When Eclipse is running, select the menu item Help | Install new Software... The Available Software dialog displays.7. Click the [Add] button located to the right of the Work with field. The Add Repository dialog displays.6SAP Mobile Platform 11. Agentry App Development8. Click the [Archive] button to the right of the Location field. In the file explorer window now displayed, navigate to and select the archive file for the Agentry Editor plug-in from the first step in this procedure. Click [OK] after returning to the Add Repository screen. This returns you to the Install dialog, where the Agentry Editor plug-in (either 32-bit or 64-bit) is listed.Agentry App Development7 12. Agentry App Development 9. Check the box for the Agentry Editor and click the [Next >] button. The Install Details dialog displays.10. Click the [Next >] button to proceed. The License Agreement dialog displays.8SAP Mobile Platform 13. Agentry App Development11. Select the radio button below the license information to accept the agreement and click the [Finish] button. During this process a security warning is displayed related to unsigned content. This is a result of certain .jar files not having been signed. You can safely continue with the installation by selecting the option to continue in the warning dialog. The installation will commence and a status dialog is displayed.Agentry App Development9 14. Agentry App Development12. When the plug-in has been installed, a prompt is displayed to restart Eclipse. Select the [Restart Now] button. When Eclipse restarts, go to the workbench. Select the menu item Window | Open Perspective | Other... The Open Perspective dialog displays, where the two Agentry perspectives are now listed.13. Either of these may be selected to begin working with the Agentry Editor. The Eclipse environment and Agentry Editor plug-in are installed on your system.10SAP Mobile Platform 15. Agentry App Development Next Additional configuration of Eclipse is needed as it relates to the Agentry Editor plug-in. This configuration is performed within the Eclipse Platform and includes the following general items: Agentry projects work with several file types. You must create file associations within Eclipse for these types to allow the platform to properly handle, display, and edit them. Script files, including SQL and shell or batch scripts created in Agentry Editor are saved with a Unicode encoding. The default file encoding for an Eclipse workspace is different. You must modify file encoding options within the Eclipse preferences. When working with a database back end system, you must configure the Data Source Tools installed with Eclipse in order for the Agentry Editor connector studio to work with a database back end.It may also be necessary to complete the configuration of one or more Agentry Servers. A publish from the Editor is a part of the Server configuration process as it relates to the Agentry application projects system connections. If connectivity was already configured between the Agentry Server and the back end system, the publish is not necessary for connection configuration.Agentry Editor and Eclipse Platform Configuration Overview After the Agentry Editor plug-in has been installed has been installed to Eclipse there are configuration tasks to be accomplished. All tasks are performed from within the Eclipse Platform itself. These tasks relate to several areas of the Agentry Editor and its management of application projects. The information provided concerning these configuration tasks should be considered a recommended best practice. For a particular development environment, different options or configurations can be implemented based on need. Contributing factors and items of consideration include the overall uses for the Eclipse implementation. Connector Studio and the Data Tools Platform The Data Tools Platform (DTP) is a project for the Eclipse platform that provides several powerful tools for work with different data sources. The Agentry Editor leverages the power of this project by extending the tools provided in the Connectivity DTP subproject with the Agentry Connector Studio. The Agentry Connector Studio is a tool within the Agentry Editor plug-in that allows for the development of object, transaction, and step definitions using the available schema information of a data source. When an Oracle or SQL Server database system is that data source there is some configuration needed within certain Connectivity components. Specifically, connections must be configured to these database systems in order to access this schema information. The configuration of a connection includes the creation of a Driver Definition and a Connection Profile within the Connectivity tools. The procedure provided on configuringAgentry App Development11 16. Agentry App Development these items will be an example on configuring these tools for the Agentry Editor. For complete information on all configuration options as well as descriptions on the functionality and uses for these tools see the Eclipse.org website. Java Projects If the application being developed or configured includes a Java Virtual Machine system connection, a Java project should be created within the Eclipse platform. This project should include the Agentry Java API version 5, as well as any other needed resources to properly build the Java logic for the mobile applications data synchronization. This will also expose the data members of the Java resources to be used to the Agentry Connector Studio. This will then allow for objects, transactions, synchronization steps, and properties to be defined based on the information provided by the Java packages in the Java project. This process is performed using the Eclipse New Java Project wizard. The new Java project can be created before or after the Agentry application project is created, but does require the Agentry Development Server to be installed and accessible to the host system of the Eclipse platform, as this location includes the Agentry Java API JAR file to be used in the Java project. File Associations and File Encoding An Agentry application project can contain several different file types as a part of the project definitions. These can include scripts for SQL, batch files, and shell scripts, Java source files, bitmap files and large markup files related to XML processing. Configuration of the Eclipse Platform and the tools outside of, but still used by the Agentry Editor plug-in for Eclipse, can be needed in order for these different files to be handled correctly. Also, most of the above mentioned files are stored as text files, with the obvious exception being bitmap files for image definitions. The encoding of these text files when created by the Agentry Editor is a unicode format of UTF-16. Files for other purposes outside of the Agentry application project may not be encoded in this format. Therefore the configuration related to file encoding must be performed in a manner that supports the different file encoding formats that may be needed. Creating Java Projects for Agentry Java API Development Prerequisites Before creating a Java project in Eclipse for use with Agentry Java API development work, the following items must be addressed: 12The SAP Mobile SDK installer must have been successfully run on the same system as the Eclipse and Agentry Editor plug-in have been installed; or, to a system that is accessible from this system. All Java resources needed for the development work should be accessible and available to the Eclipse platform host system. This can include jar files as well as other code and documentation (i.e. Javadoc archives) resources that may be needed for the development work.SAP Mobile Platform 17. Agentry App Development SAP Java Connector (SAP JCo) version 2.1.8, or any later 2.x version, is required for development and runtime environments in which the Agentry SAP Framework Foundation is used. JCo version 3.0 or later is not supported at this time. Many mobile applications that make use of the Java Virtual Machine system connection type include multiple layers of Java code libraries that reside logically between the Agentry Java API and the logic for the specific mobile application. In such situations these other libraries must exist in a location that is always available to the Eclipse platform. Determine the proper version of the JRE to be used for the Java development portion of the application. The Ganymede release of Eclipse requires the JRE version 1.6. The development project may need a different version of the JRE based on the requirements of the back end system with which synchronization will occur through the Java system connection. A part of creating the Java project in Eclipse is the optional designation of the specific JRE version to use. The Java Perspective should be open in Eclipse. Note that by default this perspective is always open, though it can be closed at any time. To reopen this perspective, select the Windows | Open Perspective | Other... menu item in Eclipse. Select the Java (default) perspective in the list shown.Task This procedure provides the basic steps of creating a Java project to contain the development work performed with the Agentry Java API. When this procedure is complete a Java project will exist in the current Eclipse workspace that will include the resources needed for performing development work related to the Java Virtual Machine system connection type. This project will include: The Agentry Java API jar file as installed by the SAP Mobile SDK. A source folder location for Java logic created for the mobile application. Any other resources that may be needed for the project (e.g. sapjco.jar).This procedure is not intended to be a comprehensive discussion on Java projects created in the Java Perspective in Eclipse, nor is it a discussion intended for the novice Java developer. A level of understanding and knowledge is assumed on the part of the reader related to these topics. Full information on the JDT project, which includes the Java Perspective, can be found at the Eclipse help site: http://help.eclipse.org/documentationAt the above link see the documentation matching the Eclipse version you installed for the Agentry Editor plug-in. 1. Start the Java Project Wizard in Eclipse using one of the following methods: Select the menu item File | New | Java Project.Agentry App Development13 18. Agentry App Development Right click in the Package Explorer View in the Java Perspective and select the pop-up menu item New | Java Project. Right click in the Project Explorer View provided with the Eclipse Platform and select the popup menu item New | Project. In the screen displayed, select the tree control item Java | Java Project.Any one of these actions will display the New Java Project wizard. 2. In this first wizard screen, begin by giving the project a name. This will be the identifier for the Java project in the Eclipse Project and Package Explorer views. Then: a) Select the Use Default Location checkbox to store the project resources within the default location within the current Eclipse workspace; alternately, deselect this box to specify a different location if needed. b) In the JRE section specify the JRE version for the Java development project. This selection must match the needs of the back end system for which the mobile application development work will be performed. This need not be the same JRE version as Eclipse uses for its own execution. The version of the JRE to be used must be installed prior to making this selection. The third option is to select a Java execution environment. c) The Project Layout specifies the location of the source and built class files for the Java project. The default is the separate locations for source and output files. The default folders are src and bin, respectively, which will reside as sub-folders to the project folder in the Eclipse workspace. These locations can be modified by clicking the Configure default hyperlink in this section. d) The new project can be added to a Working Set. If unfamiliar with working sets in Eclipse, see the help topic Working Sets in the Eclipse publication Workbench User Guide. 3. Once these options are set, click the [Next >] button to proceed. The next screen of the New Java Project wizard is displayed. This screen contains multiple tabs for further configuration of the new Java projects build settings, including source file location, included projects, libraries, and the build order and export. 4. Set the Source options as needed for the given project. Options here include selecting additional source folders outside the workspace, adding new folders to the project within the workspace that will be used as source folders, and other source file-related tasks. 5. Select the Projects path to set other projects to be included on the build path for the current project. This project must reside in the same workspace as the new project being created. Once added, options exist to select the files or sources within the project to be used. The build order for the project selected here is set in the Order and Export tab. 6. Select the Libraries tab. Here is where the libraries related to the Agentry Java API, as well as other libraries needed by the back end are selected and included in the project. this can also include the SAP JCo jar file, if applicable to your implementation and development work. To add libraries to the projects build path, begin by clicking the button to the right to add the type of library needed. For the Agentry Java API, click the Add External JARs... button. Navigate to the location of this Jar file, as provided by the SAP Mobile SDK14SAP Mobile Platform 19. Agentry App Development installer. Once added, you can expand the new node for this jar file and add the Javadoc source for the Agentry Java API. This is a ZIP archive named Agentry-v5doc.zip. 7. Once the libraries have been added, select the Order and Export tab. Here the build order is specified for the libraries and external projects for the new Java project. The specific build order is completely dependent on the project being created. However, the JRE System Library will likely always be first. Within this order, the Agentry Java API library should be ordered before any libraries or projects that extend the Agentry classes or interfaces. Also, it is likely any resources from the back end system should be ordered before the mobile application-specific items, which may include application suite libraries, as it is likely these too will extend or access these items. Once the build order is set, click the [Finish] button to create the new Java project. A new Java project will be created in the current Eclipse workspace. This project will now be accessible to the Agentry application project. When defining Java steps, or complex table or data table Java synchronization components, it will be possible to select items contained in the Agentry Java API, as well as those in the other libraries and projects for the Java project. Next Changes to the projects configuration can be made by selecting the project in the Project Explorer or Package Explorer and selecting the Properties menu item. Configuring Eclipse File Associations for Agentry Projects Prerequisites The following items must be addressed before performing this procedure: For Eclipse implementations to which the Agentry Editor plug-in was added, review the current file associations before making any modifications. Any current configuration of file associations for file types of .sql, .bmp, .bat, and .sh should be noted. Determine the desired editor within Eclipse to use for each of the file types that may be a part of the Agentry application project. This may be done now or during this configuration procedure.Task In this procedure the file associations within Eclipse will be configured for the file types that may be a part of an Agentry application project. These file associations will determine which editor or view within Eclipse will be used to display the file contents and allow those files to be edited. The file associations configured in this procedure are those available in Eclipse as provided by the Agentry Editor installer. If there are other tools available for a particular implementation, those may be used as preferred or desired. The process for creating these file associations is the same. The selection of the particular tool within Eclipse for a particular fileAgentry App Development15 20. Agentry App Development type is dependent on those available and preferred. Eclipse must be running to make these modifications. Specifically the editors for bitmaps (.bmp), Windows batch files (.bat), SQL scripts (.sql), and Linux and Unix shell scripts (.sh for Agentry application purposes) will be configured in this procedure. For shell scripts and batch files the text editor provided with Eclipse will be configured in this procedure. Other tools exist for these types of files as plugins to the Eclipse Platform. If those are to be used, review the documentation and instructions provided with those tools for configuration. 1. Select the Eclipse menu option Window | Preferences. This will display the Preferences screen in Eclipse:2. In the tree control on the left, select General | Editors | File Associations. This will display the File Associations preference page:16SAP Mobile Platform 21. Agentry App Development3. In the top list on this page are the file types for which associations can be made. The bottom list contains those editors or tools configured for the file type selected in the top list. File types can also be added to the top list. Begin by selecting the item *.bmp in the top list. The list of associated editors will be empty. Click the [Add...] button to the right of this empty list to create a file association. This will display the Editor Selection list, where an internal or external editor can be selected. Here an internal editor will be used.Agentry App Development17 22. Agentry App Development4. For a bitmap file you can select the Image Detail editor in this list. Then click the [OK] button to make this selection. This returns you to the File Associations preference page, where the Image Detail editor is now configured as the default editor for bitmap files.18SAP Mobile Platform 23. Agentry App Development5. Next the remaining file associations can be created. Begin by checking the configuration of .sql files. By default the SQL File Editor is configured as the default for this file type. This is a part of the Data Tools package provided with Eclipse. You may select another editor if one is available, though this is the recommended editor for Agentry application projects. 6. The remaining file types that may need to be configured are those related to File System connections. These can be batch files for Windows deployments or shell scripts for Linux and Unix deployments of the Agentry Server. By default these file types are not listed in the Preference page for file associations. They can be added. To do this, click the [Add...] button to the right of the File types list. This will display the Add File Type screen as shown next.Agentry App Development19 24. Agentry App Development7. Enter the file extension in the format *.ext in the field provided and click the [OK] button. This will return you to the File Associations preferences page where the new file type will now be listed.8. This new file type can now be selected and an Editor can be associated with it, just as before. In the previous example Windows batch files are configured to have the Text Editor as the default editor.20SAP Mobile Platform 25. Agentry App Development 9. This procedure can now be repeated for any other file types. In the case of Linux or Unix development, the recommended file type of .sh should be added and configured. While the file extensions are not required by these operating system types for proper execution, within the Agentry application project an extension is needed. This is so a file association can be configured for proper display and management of the files. The file associations for those file types used in Agentry application projects have now been configured. In the examples provided in this procedure the following configurations have been made: Bitmap files will be displayed in the Image Detail editor. Windows batch files will be displayed in the standard Text Editor for Eclipse. Shell script files will be displayed in the standard Text Editor for Eclipse.Configuring Eclipse File Encoding for Agentry Projects Prerequisites Before performing this procedure the following items must be addressed: The Agentry Editor plug-in and Eclipse Platform must be installed. The file associations should be configured for .sql, .bat or .sh, as needed, within the Eclipse Platform. Identify the file encoding format for any Java source files that may be opened within the same workspace as the Agentry application project.Task This procedure describes the steps to configure the file encoding settings and preferences within the Eclipse platform as required by the Agentry Editor plug-in. The assumption is that the file editors for the various file types have been configured based on the recommendations provided by Syclo. If one or more different file editors are to be used for certain file types, the following procedure may or may not be valid. Those tools described here do not support or provide editor-specific file encoding, instead inheriting this behavior from the Eclipse workspace settings. This procedure configures the current Eclipse workspace to use the file encoding format UTF-16, which is a unicode format. This will then result in all text editing tools treating all text files opened in any editor as if they are encoded in this format. Certain files external the Agentry application project but possibly a part of its overall implementation may not be encoded in this format. The primary example of such files would be Java files for a JVM system connection. The Java perspective within Eclipse does have a preference setting for file encoding. This is set for an individual Java project. The proper encoding setting for Java projects is dependent upon how those Java source files were encoded upon creation. The common option for such files is the UTF-8 encoding. However, other encoding formats are possible and this should be determined before making changes.Agentry App Development21 26. Agentry App Development 1. Start the Eclipse platform and open the workspace to be used for the Agentry Editor. Once Eclipse is started, select the menu item Window | Preferences. In the tree control on the left of the Preferences screen select General -> Workspace. This will display the Preferences page for the current workspace.2. On this page look for the section Text file encoding. Select the Other radio button and then select the item UTF-16 in the associated drop down list. 3. Click the [OK] button to close the Preferences screen and apply the changes. If a Java project is not to be opened within this same workspace, or if the Java projects files have been encoded with UTF-16, no further actions are needed. Otherwise, continue on with this procedure. 4. Switch to the Java perspective in Eclipse and open the Java project for this same workspace. Select the menu item Project | Properties. This will display the Properties page for the java project:22SAP Mobile Platform 27. Agentry App Development5. In the tree control to the left select the item Resource. Then look for the section Text file encoding. Select the radio button Other and then select the proper encoding option based on the encoding of the source files in the Java project. Note that if these files are encoded in either ASCII or UTF-8, then UTF-8 can be selected. For other file encoding formats select the proper item. 6. Click the [OK] button to close the Properties page and save these changes. This procedure results in changing the Eclipse workspaces default file encoding for all text files to the unicode format UTF-16. This is the encoding in which all text files created by the Editor are formatted. The exception to this are java source files. Creating a Connection Profile for the Agentry Connector Studio Prerequisites The following items must be addressed prior to performing this procedure: The connection between the Data Source Tools and the target database uses JDBC. The desired JDBC drivers should be selected and the associated resource files (jar files or otherwise) should be located and noted. This information will be needed when creating a Driver Definition.Agentry App Development23 28. Agentry App Development If a suitable Driver Definition has already been created for the Data Source Tools, the name of the definition should be noted for use in the following procedure. In this case, a new Driver Definition will not need to be created. Information about the selected JDBC drivers should be gathered, specifically the attributes and values needed to configure a connection using the specific driver package. This will likely include the syntax for specifying the database host and server, login and password information, and the Java class or package within the JDBC driver to be used.Task The connection created in this process will be accessible through the Data Source Explorer view available in Eclipse. This view is not a part of the Agentry Editor Eclipse Plug-in but rather is provided with the Eclipse Platform. Therefore, detailed instruction and information on its functionality and behavior is not provided by Syclo. This information can be obtained from the Eclipse.org website. Once this connection is created, it will be listed in the Data Source Explorer view. From here you will be able to perform all functionality supported by the Data Source Tools plus use the Connector Studio functionality provided with the Agentry Editor. 1. Open the Data Source Explorer view by selecting the menu item Window | Show View | Other... In the tree control displayed, expand the Connectivity node and select the Data Source Explorer item. This will display the view as shown next:2. You can now create a new connection to a database using this view by either right-clicking the Databases node and selecting the menu item New...; or by clicking the tool bar button . Either will display the New Connection Profile Wizard.24SAP Mobile Platform 29. Agentry App Development3. This screen lists the database types to which a connection can be made. This selection is largely based on not just the database type, but also on the selected JDBC driver package to be used. For this example, the Connection Profile Type to be used is Generic JDBC. Give the connection profile a name and a description and click the [Next >] button.Agentry App Development25 30. Agentry App Development4. In this next screen the driver to be used for the connection is selected. If a driver profile exists that is suitable for the connection, select it from the Drivers list. In this case you can skip the next instructions on creating a new Driver profile. 5. To create a new Driver Profile, click the new Driver Profile Button Drivers list. This will display the New Driver Profile wizard.26to the right of theSAP Mobile Platform 31. Agentry App Development6. In this first tab you can select the driver template. This list will vary depending on the type of Connection Profile you are creating. In this example there is only one option, Generic JDBC Driver. Enter a name for the Driver Definition. 7. Next select the Jar List tab. This list contains the jar files for the JDBC driver package to be used for this Driver Definition. For this example the list is empty initially.Agentry App Development27 32. Agentry App Development8. Add the proper jar file(s) to this list by selecting those provided with the selected JDBC driver package. This is done by clicking the Add Jar/Zip button and then browsing to the jar file on the file system.28SAP Mobile Platform 33. Agentry App DevelopmentHere the selected item is the jar file for the jTDS 1.2.2 JDBC driver package provided by SourceForge.net. For other driver packages the selected jar file(s) will be different. 9. Next select the Properties tab. The items listed in this tab will be dependent on the selected jar file and are those items the JDBC driver requires to establish connections.Agentry App Development29 34. Agentry App DevelopmentThe values set here should be left to generic or template types of values. This driver definition, once created, can be reused for multiple actual connections to a database of the same type. The values entered here will be presented going forward when this driver definition is selected for a new Connection Profile and can be set at that time to the database specific values needed for a connection. Once these items are set, click the [OK] button.30SAP Mobile Platform 35. Agentry App DevelopmentThe New Connection Profile Wizard will now be displayed again. The values set in the fields on this screen will match those entered for the selected JDBC driver properties. 10. Now alter these settings by entering the proper values for the specific database connection to be created. In this example, the database name, URL, User name and Password are altered for a connection to a Northwind database in MS SQL Server.Agentry App Development31 36. Agentry App Development11. If the target database is available you can now test this connection by clicking the [Test Connection] button. If the connection is successful you will see the following pop-up screen.12. Click OK on this prompt. Finally, choose whether to connect when this wizard closes and also whether or not to connect automatically when the Data Source Explorer view is displayed in Eclipse. Then click the [Next >] button to view a summary of this configuration, or the [Finish] button to close this wizard.32SAP Mobile Platform 37. Agentry App Development The Data Source Explorer View will now list the new Connection Profile under the Databases node with the name you entered.The database connection created will allow for use of the schema information provided by that database in the object definition process. The developer can use the Agentry Connector Studio, accessed through the Data Source Explorer view, to select a table and to create or modify an object definition, as well as its related transactions and SQL Step definitions, based on the structure of the database table.Agentry OpenUI SDK for iOS Setup Overview The Agentry OpenUI for iOS clients is provided within the SAP Mobile Platform SDK. It is provided in a single TGZ file, referred to generally as the Agentry Client framework, and can be used to create a development project within the Xcode IDE on Mac systems. It is provided in the native Objective C programming language for iOS devices. Also included in this framework is a sample project with basic overrides of each detail screen field edit type provided as examples. When creating the project within Xcode, the developer has two options. The first is to manually create the project in Xcode, pulling in the various resources provided in the Agentry Client framework and setting the various configuration options for the project. Instructions are provided here to support this method if desired. The second, and recommended option in most situations, is to use the prebuilt empty project file provided in the Agentry Client framework, named SMPAgentryClientFrameworkSetup. This project contains all the same settings and options as described in the manual process. It can be used as is within Xcode to support a quicker and easier project setup. In general it is only necessary to create the project manually in situations where there is a need for significant differences from the recommended setup. Such situations are extremely rare and should not be necessary in most use cases. Framework Contents The resources for the OpenUI SDK are provided in the Agentry Client framework, which is found in the file SMPAgentryClientFramework-iOS-7.0.x.x.tgz. This library and the resources it contains includes all functionality of the Agentry Client for iOS and includes the OpenUI SDK to allow for the detail screen fields to be overridden with customAgentry App Development33 38. Agentry App Development controls; as well as exposing the necessary resources to rebrand the Agentry Client. Due to limitations with Apples current support of dynamic frameworks, this framework is intended to be statically linked to the application. To support testing on both iOS devices and within the simulator, the framework standard library is provided with slices for instruction set architectures armv7, armv7s, and i386. The framework contains the following directory structure after it has been expanded: //SMPAgentryClientFramework/iOS/ ./SMPAgentryClient.Framework/Versions/Current/Headers Headers needed for adapters and models of SMPOpenUI ./SMPAgentryClient.Framework/Versions/Current/Resources SMPAgentryClientResources.bundle - Image, sound, and other resources ./SMPAgentryClient.Framework/Versions/Current/SMPAgentryClient SMPAgentryClient - The static library containing the iOS Agentry Clientcode ./Samples/SMPAgentryClientFrameworkDemo/ ./Samples/SMPAgentryClientFrameworkSetup/ ./SampleApp/ ./OpenUI-app.agx - Agentry application project corresponding to the XCode demo project provided in the Samples directoryDB./OpenUIPlayersDB.txt - Sample data in SQL script for back endOpenUI for iOS Manual Xcode Project Setup Prerequisites The following items must be addressed prior to performing this procedure: 34The SAP Mobile Platform SDK 3.0 contains the necessary resources for this procedure and must be installed. Note the installer is only available for Windows systems and the iOSSAP Mobile Platform 39. Agentry App Developmentframework must be manually copied to the Mac system after installation. This framework file can be found in the directory AgentryToolkit/OpenUISDK/iOS/ SMPAgentryClientFramework-iOS-7.0.x.x.tgz Xcode version 4.6 must be installed to the Mac system where the project is to be created.Task This procedure provides the steps necessary to create a project in Xcode that makes use of the Agentry Client framework for iOS. Creating this project is necessary to make use of the OpenUI SDK as well as to rebrand the Agentry Client for iOS. This project is created on a Mac system with the Xcode IDE version 4.6 installed. Note: This procedure provides the manual steps to create this project. In most use cases this is not necessary and the project provided with the SMPAgentryClientFrameworkiOS-7.0.x.x.tgz file can be used. This file is located in the directory ./Samples/ SMPAgentryClientFrameworkSetup after the TGZ file has been expanded. 1. Expand the framework archive SMPAgentryClientFrameworkiOS-7.0.x.x.tgz into a directory on the system. In these instructions this base directory is represented by the value . 2. Within Xcode, create a new project, selecting iOS Application | Empty Application. 3. In the Build Settings for the main target of the project, set the Framework Search Path to: /SMPAgentryClientFramework/iOS/** 4. In the Build Settings for the main target of the project, set the Header Search Path to: /SMPAgentryClientFramework/iOS/ SMPAgentryClient.framework/Headers/** 5. In the Build Settings for the main target of the project, set the Other Linker Flags to: ObjC -framework -SMPAgentryClient 6. In the Build Phases section for the main target of the project, add the following resources to the Link With Dynamic Libraries section: libc++.dylib libiconv.dylib libicucore.dylib libsqlite3.dylib libxml2.dylib AudioToolbox.framework AVFoundation.framework CFNetwork.framework CoreLocation.framework CoreMedia.framework CoreText.frameworkAgentry App Development35 40. Agentry App Development CoreVideo.framework QuartzCore.framework Security.framework CoreGraphics.framework Foundation.framework UIKit.framework 7. In the Build Settings for the Xcode project set the Strip Linked Product option to No. 8. Add the resource bundle to the project by selecting the menu item File | Add Files to Project and add the location: / SMPAgentryClientFramework/iOS/SMPAgentryClient.framework/ Resources/SMPAgentryClientResource.bundle 9. Modify the main.m file within the project by replacing the app delegate class name and return statement: New app delegate class name: @SMPAgentryClientAppDelegate New return statement: return UIApplicationMain(argc, argv, nil, @"SMPAgentryClientAppDelegate");10. After building and launching the project, the standard Agentry Client should run in either the simulator or on the client device. With the completion of this procedure a project has been created in Xcode using the resources provided in the Agentry Client framework for iOS. Next You can begin developing custom controls using the OpenUI SDK and/or rebranding the Agentry Client for iOS devices by modifying the resource bundle.Agentry OpenUI SDK for Android Setup Overview The Agentry OpenUI for Android clients is provided within the SAP Mobile Platform SDK. It is provided in a single ZIP archive, referred to generally as the Agentry Client framework, and can be used to create a development project within a Java IDE. Eclipse was used to create these resources by SAP. It is provided in the Java programming language. Also included in this framework is a sample project with basic overrides of each detail screen field edit type provided as examples. In order to create the project, it is necessary to have the following tools installed Eclipse Android SDK - API versions 10, 15, and 17 Java SDK ANT If building with ANT - This is provided as a part of the Eclipse installation, but mayalso be installed separately to support rebranding-only builds36SAP Mobile Platform 41. Agentry App Development In order to set up an Android development environment, there are different options available and the proper option is up to the developer and the environment currently in place. Both include the usage of the Android Development Toolkit (ADT), an Eclipse plug-in. A summary of each option is provided below, and step by step instructions are available for each in subsequent sections, which include URLs to the Android developer site where both the downloads and installation instructions are provided. Once the Android development environment is created, the projects provided in the Agentry Client framework archive for OpenUI can be directly imported into the Eclipse workspace. Once this process is complete, you can begin developing the custom controls needed for your mobile application. Instructions are also provided on creating the projects within the Eclipse workspace and information on items such as build order and similar details are included. Setup for Android Development - Installing the ADT Bundle To create the Android development environment you can download and install the Android Development Toolkit (ADT) Bundle. This bundle includes both the Eclipse IDE as well as the ADT plug-in for Eclipse already bundled together and configured. As a part of the ADT bundle the Android SDK is included and installed. After installing this bundle it is necessary to use the SDK Manager within the Android SDK to verify and/or install the required API versions of the SDK. Setup for Android Development - Installing the ADT Plug-in Manually If you have an existing installation of Eclipse, it is possible to install the ADT plug-in to it, rather than installing the full Eclipse IDE and plug-in. The primary difference in this process from the full ADT bundle option is that you will need to manually configure the preferences within Eclipse for the ADT after it is installed to point it your Android SDK installation. Setup for Android Rebranding Only If you will only be rebranding the Agentry Client for Android and will not be developing customer controls using the OpenUI SDK, you do not need to setup an Android development environment. Rather, you can simply install the Ant build scripting tool and make changes to certain files extracted from the framework archive. You can then run an Ant build command to create a rebranded and/or resigned Agentry Client for Android. Framework Contents The resources for the OpenUI SDK are provided in the Agentry Client framework, which is found in the file SMPAgentryClientFramework-Android-7.0.x.x.zip. This archive and the resources it contains includes all functionality of the Agentry Client for Android and also includes the OpenUI SDK to allow for the detail screen fields to be overridden with custom controls; as well as exposing the necessary resources to rebrand the Agentry Client. The framework contains the following directory structure, relative to the base directory into which it is extracted:Agentry App Development37 42. Agentry App Development./Sample/ OpenUI-app.agzprojectAgentry application project corresponding to the Java sample./com/ Beginning of the folder structurein which the sample project and extensions are contained. ./SAP/Mobile/Platform/android/AgentryAndroidClientSolution Location of the project containing the buildable resources that produce the standard Agentry Clientfor Android ./vendor/Installing the ADT Bundle With Eclipse Prerequisites The following items must be addressed prior to performing this procedure: This procedure includes both an Eclipse installation as well as updates to the Android SDK, both of which are a part of the ADT bundle. Instructions for this installation are provided on the Android developer site, as referenced in the main procedure. Access to the bundle itself as well as to the instructions requires internet access. The Java Development Kit installer should be downloaded and available. Information and the installer can be found by Clicking Here. Alternately, you can enter the following URL into your web browser: http://www.oracle.com/technetwork/java/ javase/downloads/index.htmlTask This procedure provides information on installing the Android Development Toolkit (ADT) Bundle. This bundle includes both Eclipse and the ADT plug-in, as well as a basic installation of the Android SDK, all of which are necessary components for development of custom controls using the SAP Agentry OpenUI. Additionally, it is necessary to install the Java SDK version 1.7, and to configure the system upon which it is installed by making changes to the Environment variables.38SAP Mobile Platform 43. Agentry App Development 1. Install the Java Development Kit (JDK). Note the installation location, as this will be needed later in this procedure. 2. Create a new Environment Variable for Windows by right clicking on My Computer, selecting Advanced system settings, and then clicking Environment Variables. Create a System Variable named JAVA_HOME and set its value equal to the location in which the JDK was installed in the previous step. 3. Next the Android Development Toolkit Bundle must be downloaded and installed. Instructions for this procedure are provided on the Android developer site. In a web browser, navigate to the download page for the ADT Bundle by Clicking Here. Alternately enter the following URL in your web browser: http:// developer.android.com/sdk/installing/bundle.html 4. After installing the ADT Bundle, it is necessary to update the Android SDK that was a part of the installation. Open the folder under the Eclipse directory create in the previous step containing the Android SDK and start the SDK Manager. Here, add the required API versions from the SDK, which include versions 10, 15, and 17. For information on the SDK Manager, Click Here. Alternately, enter the following URL in your web browser: http://developer.android.com/sdk/installing/addingpackages.html With the completion of this procedure, the Android development environment needed for working with the OpenUI SDK for Android is in place. Next See the procedure SAP Mobile Platform Agentry OpenUI for Android Project Setup for instructions on creating and importing the projects within the OpenUI SDK. Installing the ADT Plug-in to an Existing Eclipse Instance Prerequisites The following items must be addressed prior to performing this procedure: An existing Eclipse installation must already exist. If you wish to install both the ADT plug-in and Eclipse, see the procedure Installing the ADT Bundle With Eclipse. The Java Development Kit 7 (a.k.a. JDK version 1.7) installer should be downloaded and available. Information and the installer can be found by Clicking Here. Alternately, you can enter the following URL into your web browser: http://www.oracle.com/ technetwork/java/javase/downloads/index.htmlTask This procedure provides information on installing the Android Development Toolkit (ADT) Plug-in to an existing Eclipse instance. This is a necessary component for development of custom controls using the SAP Agentry OpenUI.Agentry App Development39 44. Agentry App Development Additionally, it is necessary to install the Java SDK version 1.7, and to configure the system upon which it is installed by making changes to the Environment variables. 1. Install the Java Development Kit (JDK) version 1.7. Note the installation location, as this will be needed later in this procedure. 2. Create a new Environment Variable for Windows by right clicking on My Computer, selecting Advanced system settings, and then clicking Environment Variables. Create a System Variable named JAVA_HOME and set its value equal to the location in which the JDK was installed in the previous step. 3. Next the ADT Plug-in can be installed to the Eclipse instance. This process can be handled either through Eclipse itself, or by downloading the PLug-in and then installing to Eclipse locally. Instructions for this procedure are provided on the Android developer site. In a web browser, navigate to the page for the ADT Plug-in by Clicking Here. Alternately, enter the following URL into your web browser: http://developer.android.com/sdk/ installing/installing-adt.html This page contains information on both installing and configuring the plug-in within Eclipse. 4. After installing the ADT plug-in, it is necessary to update the Android SDK that was a part of the installation. Open the folder under the Eclipse directory create in the previous step containing the Android SDK and start the SDK Manager. Here, add the required API versions from the SDK, which include versions 10, 15, and 17. For information on the SDK Manager, Click Here. Alternately, enter the following URL in your web browser: http://developer.android.com/sdk/installing/addingpackages.html With the completion of this procedure, the Android development environment needed for working with the OpenUI SDK for Android is in place. Next See the procedure SAP Mobile Platform Agentry OpenUI for Android Project Setup for instructions on creating and importing the projects within the OpenUI SDK. SAP Mobile Platform Agentry OpenUI for Android Project Setup Prerequisites The following items must be addressed prior to performing this procedure: 40The SAP Mobile Platform SDK must be installed, with the Agentry Toolkit being one of the selected components during installation. An Android development environment must have been created, per the instructions provided. This includes Eclipse with the ADT plug-in installed, as well as the installation of the Android SDK with the proper API versions installed.SAP Mobile Platform 45. Agentry App Development Task This procedure describes the necessary steps to setup a development environment within Eclipse that can be used for development of customer controls using the SAP Agentry OpenUI SDK for Android clients, as well as for rebranding of the Agentry Client for Android. When this procedure is complete, a series of development projects will exist in the Eclipse workspace that will allow you to both development customer controls as well as rebrand the Agentry Client for Android and ultimately produce a new application package (.apk file) for distribution to Android devices. 1. Within the directory where the SAP Mobile Platform SDK was installed, locate the file at AgentryToolkitAgentryOpenUISDKSMPAgentryClientFrameworkAndroid-7.0.x.x.zip 2. Open the archive and extract the contents to an accessible location. 3. Launch Eclipse if not already running. Within Eclipse, you should have the ADT perspective open and have the desired workspace for the projects to be created selected. 4. Within Eclipse, select the menu item File | Import | General | Existing Projects into Workspace. 5. Navigate to the location of the files extracted from the Agentry Client for Android framework. There are three directories here: Sample SAP vendor 6. Select each for import into the Eclipse workspace. This imports the projects within the OpenUI SDK to allow for custom controls and rebranding of the Agentry Client. 7. Perform a clean of all projects once imported. 8. Once this is complete, you can configure the preferences of the projects. For the project AgentryAndroidClientSolution you should specify the following build order in the project preferences: AndroidOpenSource Codeus com_actionbarsherlock com.google.zxing.client.android.CaptureActivity MAF_Controls OI Distribution Library OI File Manager polidea_treeview AgentryAndroidClientResources AgentryAndroidClientSolutionOnce this is complete, the development environment for the Agentry Client for Android has been created. To develop custom controls using the OpenUI SDK, all extension classes shouldAgentry App Development41 46. Agentry App Development be created in the AgentryAndroidClientSolution project, within the package com.sap.mobile.platform.client.openui.extensions For rebranding and/or resigning of the Agentry Client for Android devices, changes should be made to the resources in the AgentryAndroidClientResources project.Agentry OpenUI for Windows Setup Information in order to use OpenUI SDK for the Windows clients, the setup is straight forward. All methods, object, and types within the SDK for Windows are exposed via Reflection in the .NET Framework. To create a project, you must first install the standard .NET Agentry Client for Windows. Note that if installing the client to Program Files, it is necessary to have administrator privileges. Alternately you can install the client to a directory to which you have privileges, such as your user directory. Within the installation folder for the client, there is the AgentryClientSDK.dll assembly. In this same folder, create a sub-folder named CustomControls. Within Visual Studio (2012 or later) create a project targeting the .NET 4.5 Framework. You must add a reference to the AgentryControls.dll assembly. To create your custom control, it must implement the AgentryClienSDK.ICustomerAgentryControl interface. The Agentry Client will set the Data Context property of your custom control to an object that implements the Agentry ADK interface and that corresponds to the type of control. Once youve built your customer control, copy the assembly into the CustomControls folder of the Agentry Client installation for testing. To deploy, you can bundle the Agentry Client installer to include the custom controls. This is accomplished using the Agentry Client Branding SDK.Installing the Agentry Test Environment Prerequisites Address the following items prior to performing this procedure: 42The SAP Mobile Platform SDK 3.0 installer must already have been run and access to the items it installed must be available form the system to which the Agentry Test Environment is being installed. Determine the installation location of the Agentry Test Environment on the intended host system. By default this location is C:AgentryTest Environment. You can specify a different location during the installation if desired. Log into the host system as an administrator, with privileges to install software to the desired location.SAP Mobile Platform 47. Agentry App Development Task This procedure describes the steps necessary to install the Agentry Test Environment software component. This component is used as a client test tool during development of applications using the Agentry archetype. It is not intended for end users. It can only be installed to Windows desktop systems and cannot be installed to mobile devices. Perform this procedure to: Test modifications of the mobile application, when those modifications affect client-side behavior or client-server communications or synchronization. Test or debug run time issues in a Production environment. The Agentry Test Environment can be connected to the Agentry Production Server just as a normal client can.When this procedure is complete, the Agentry Test Environment is available for use to test the client-side behaviors of any modifications made to the mobile application. 1. Start the Agentry Test Environment installer on the host system where you are installing this component by running the program Agentry_7_0_x_x_TestEnvironment.exe (NOTE: The value x represents the latest service pack or patch release of the system, depending on the version downloaded). This displays the Welcome to the Agentry Test Environment Setup Wizard screen. 2. Click the [Next] button to advance the wizard. This displays the License Agreement screen. 3. Click the [Yes] button to accept this agreement and advance the wizard. The Choose Install Location screen is displayed. 4. Enter the desired directory path in the Destination Folder field. This can be a new path, an existing location selected by clicking the [Browse] button, or the default location. Click the [Next] button to install the Agentry Test Environment to the specified directory. This displays the Shortcuts for Agentry Test Environment screen. 5. Select the desired shortcut locations by selecting or deselecting the listed shortcut options. Once the shortcuts are configured, click the [Install] button to begin the installation of the Agentry Test Environment software component. The selected shortcuts are created by the installer. The Installation Status screen is displayed next indicating the installation progress. When the installation is complete, the Completing the Agentry Test Environment Setup wizard screen is displayed. 6. To start the Agentry Test Environment now, leave the box checked on this screen. Otherwise, deselect this box. Click the [Finish] button to close the wizard. With the completion of this procedure, the Agentry Test Environment is installed to the selected location and is available for use in testing mobile applications in development, configuration, implementation, or production issue resolution scenarios.Agentry App Development43 48. Agentry App Development Next Just as with a standard client installation, the Agentry Test Environment needs to connect to an Agentry Server to perform an initial transmit. Prior to performing this transmit, the proper client platform to be mimicked, enabling or disabling scan and GPS simulations, and other similar selections should be made.Agentry SAP Framework Foundation Installation Overview The Agentry SAP Framework Foundation is implemented as an ABAP Add-On and is installed to the SAP system as a part of the implementation of the SAP Mobile Platform only when building or supporting mobile applications built in the Agentry archetype, and only when those mobile applications synchronize data with SAP systems. If both of these are not a part of your environment, this component is not installed. The framework includes both the Administration and Monitoring Portal, and the Integration Framework. The Integration Framework provides the integration point to the SAP system for the Agentry Server. This then allows the Agentry Server to synchronize data with the SAP system for the mobile application. Included in the Integration Framework is the Configuration Portal used during implementation to create synchronization components of the mobile application. The Administration and Monitoring Portal provides the tools and user interface to allow for the administration, configuration, and care and feeding tasks for the Agentry SAP Framework Foundation. These include security settings, log settings, user monitoring, and other similar tools. There are also two additional resources needed in both the development and runtime environments when using the Agentry SAP Framework Foundation component. The first is an API contained in the Java file SAPCommon-130881.jar. The second is a configuration file, which must be created manually, named JavaBe.ini. Both of the files must reside within the folder where the Agentry Server has been installed. Additionally, the SAPCommon-130881.jar must be an available resource for any Java development projects related to the mobile application being developed. The installation of the Agentry SAP Framework Foundation includes the following main tasks: 1. Verify the system requirements. 2. Install the Agentry SAP Framework Foundation software and support packages and place the SAPCommon-130881.jar file in the proper Agentry Server directory. 3. Create the JavaBe.ini configuration file and place it in the Agentry Servers installation folder. Agentry SAP Framework Foundation Component The following table lists the minimum version of the items required for the Agentry SAP Framework Foundation Component installation to the SAP system system. The software component for Agentry SAP Framework Foundation is SMFND release 600_700.44SAP Mobile Platform 49. Agentry App DevelopmentSoftware Requirements Software ComponentReleaseService PackSAP_ABA700SP14SAP_BASIS700SP14Installing Agentry SAP Framework Foundation Prerequisites The following items must be addressed prior to performing this procedure: Ensure you have the current versions of kernel, TP and R3trans. Current SPAM / SAINT Update - Compare the short text of the last SPAM / SAINT update you imported with that of the SPAM / SAINT Update in the SAP Service Marketplace. If the version of the SPAM / SAINT Update in the SAP Service Marketplace is more recent, import it. Verify the required software components have been installed, as listed in the system requirements for the Agentry SAP Framework Foundation. Verify the required support packages have been installed, as listed in the system requirements for the Agentry SAP Framework Foundation. No SAP password is required.Task Additional Information Space required in the transport directory: approximately 10 MB Total runtime: approximately 0.5 hour SAP ABAP Add-Ons: Integration Foundation Add-On: SMFND_600700_NW700.SARLanguage Support The Agentry SAP Framework Foundation supports the following languages: English German Brazilian Portuguese French Spanish KoreanAgentry App Development45 50. Agentry App Development Japanese Simplified Chinese1. Log on to your SAP system as client 000 and as a user that has system administrative privileges. Do not use the SAP* or DDIC users. 2. Import the required user language(s) for all components that have already been installed. You must perform this language import prior to the installation of the Agentry SAP Framework Foundation. 3. Load the software package into your system via the Add-On Manager, using the transaction code SAINT. For more information about this, see the online documentation for the Add-On Installation Tool. Select the help function in the application toolbar and navigate to Online Documentation | Loading Installation Packages. 4. Start the installation of the Agentry SAP Framework Foundation using the Add-On Installation Tool, accessed from the transaction SAINT. For more information about this, see the online documentation for the Add-On Installation Tool, selecting the help function on the toolbar. 5. Activate the Services for the Web Dynpro ABAP Applications a) Start transaction SICF. b) Activate all services under the node default_host/sap/bc/webdynpro/ Syclo 6. Define Intervals for Number Range Objects /SYCLO/C_1 and /SYCLO/C_2 a) b) c) d) e)46Start transaction SNRO. Enter the number range object /SYCLO/C_1. Select Number Ranges | Intervals. Maintain or create the intervals 01 and 02. Repeat these steps for the number range object /SYCLO/C_2 and maintain the intervals 01, 02, 03, 04, and 05. For example:SAP Mobile Platform 51. Agentry App Development7. Next, copy the file SAPCommon-130881.jar from the SAP Mobile SDK package to the installation location of the Agentry Server. With the completion of this procedure the Agentry SAP Framework Foundation has been installed to the SAP system and is available for developers to begin creating the necessary components for a mobile application built using the Agentry archetype. Next The final item to address is the creation of a configuration file for the Agentry Server. See the instructions Creating the JavaBE.ini File for SAP Systems for details. Creating the JavaBE.ini File for SAP Systems Prerequisites The following items must be addressed prior to performing this procedure: The JavaBE.ini file is needed only when using the Agentry SAP Framework Foundation. This file is needed by the Agentry Server. This component should be installed, per instructions found in the SAP Mobile SDK installation guide.Agentry App Development47 52. Agentry App Development This file should NOT be manually placed within the SAP Mobile Platform Runtime environment. Rather it should be packaged and deployed per documented procedures for deploying Agentry applications.Task This procedure documents the steps necessary to create the JavaBE.ini configuration file for use by the Agentry Server. The SAPCommon-130881.jar processes this file at runtime and expects certain sections and settings to be present. These revolve primarily around connectivity and authentication to and with the SAP System. In addition to these required sections, in some implementations developers choose to add additional configuration sections. These additional sections are valid, but are outside the scope of this document. Typically these settings are consumed by the synchronization logic built for a specific application. 1. Create a new plain text file named JavaBE.ini and save it in the installation folder of the Agentry Server. 2. Using a plain text editor, open the JavaBE.ini file for editing. 3. Create the [HOST] section with the following settings: [HOST] server= APPNAME=4. Create the [CONFIG] section exactly as shown below. Note there are other options for the source setting listed in this section, but the default is sufficient for initial configuration. Further information on this is provided in development guides. [CONFIG] source=SAP5. Create the [CLIENT_NUM] section with the following setting: [CLIENT_NUM] CLIENT=6. Create the [SYSTEM_NUM] section with the following setting: [SYSTEM_NUM]48SAP Mobile Platform 53. Agentry App DevelopmentSYSNUM=7. Create the [LANGUAGE] section with the LANG option set to the two character SAP language key matching the language of the SAP system: [LANGUAGE] LANG=8. Create the [LOGGING] section, with the logging level set based on the information provided after the example: [LOGGING] Level= 1 - Fatal Errors only 2 - Errors and above 3 - Warnings and above 4 - Informational messages and above 5 - Debugging messages and above 6 - Trace level debugging 9. Create the [LOGON_METHOD] section with the following settings, using the descriptions of settings provided below the example. The option set here will specify whether the [GLOBAL_LOGON] or [GROUP_LOGON] section is needed as well: [LOGON_METHOD] LOGON_METHOD=USER _AUTH - Standard User ID and password authentication is used. USER_AUTH_GLOBAL - Pooled connections using a single user ID and password; requires the section [GLOBAL_LOGON] to also be created. USER_AUTH_GROUP - User ID and password authentication with the SAP Message Server (load balancing) is used; requires the section [GROUP_LOGON] to also be created. 10. If the LOGON_METHOD is set to USER_AUTH_GLOBAL, create a new section named [GLOBAL_LOGON] as shown next: [GLOBAL_LOGON] UID=Agentry App Development49 54. Agentry App DevelopmentUPASSWORD= SHAREDCONNECTIONS=11. If the LOGON_METHOD is set to USER_AUTH_GROUP, create a new section named [GROUP_LOGON] as shown next: [GROUP_LOGON] MESSAGE_SERVER= GROUP_NAME= SYSTEM_ID= CLIENT=12. Create the section [REQUIRED_BAPI_WRAPPER] with the settings and values listed exactly as shown next: [REQUIRED_BAPI_WRAPPER]com.syclo.sap.bapi.LoginCheckBAPI=/SYCLO/ CORE_SUSR_LOGIN_CHECK com.syclo.sap.bapi.RemoteUserCreateBAPI=/SYCLO/ CORE_MDW_SESSION1_CRT com.syclo.sap.bapi.RemoteParameterGetBAPI=/SYCLO/ CORE_MDW_PARAMETER_GET com.syclo.sap.bapi.SystemInfoBAPI=/SYCLO/CORE_SYSTINFO_GET com.syclo.sap.bapi.ChangePasswordBAPI=/SYCLO/ CORE_SUSR_CHANGE_PASSWD com.syclo.sap.bapi.CTConfirmationBAPI=/SYCLO/ CORE_OUTB_MSG_STAT_UPD com.syclo.sap.bapi.DTBAPI=/SYCLO/CORE_DT_GET com.syclo.sap.bapi.GetEmployeeDataBAPI=/SYCLO/ HR_EMPLOYEE_DATA_GET50SAP Mobile Platform 55. Agentry App Developmentcom.syclo.sap.bapi.GetUserDetailBAPI=/SYCLO/CORE_USER_GET_DETAIL com.syclo.sap.bapi.GetUserProfileDataBAPI=/SYCLO/ CORE_USER_PROFILE_GET com.syclo.sap.bapi.PushStatusUpdateBAPI=/SYCLO/CORE_PUSH_STAT_UPD com.syclo.sap.bapi.RemoteObjectCreateBAPI=/SYCLO/ CORE_MDW_USR_OBJ_CRT com.syclo.sap.bapi.RemoteObjectDeleteBAPI=/SYCLO/ CORE_MDW_USR_OBJ_DEL com.syclo.sap.bapi.RemoteObjectGetBAPI=/SYCLO/ CORE_MDW_SESSION_GET com.syclo.sap.bapi.RemoteObjectUpdateBAPI=/SYCLO/ CORE_MDW_SESSION_UPD com.syclo.sap.bapi.RemoteReferenceCreateBAPI=/SYCLO/ CORE_MDW_USR_KEYMAP_CRT com.syclo.sap.bapi.RemoteReferenceDeleteBAPI=/SYCLO/ CORE_MDW_USR_KEYMAP_DEL com.syclo.sap.bapi.RemoteReferenceGetBAPI=/SYCLO/ CORE_MDW_SESSION_GET com.syclo.sap.bapi.RemoteReferenceUpdateBAPI=/SYCLO/ CORE_MDW_SESSION_UPD com.syclo.sap.bapi.RemoteSessionDeleteBAPI=/SYCLO/ CORE_MDW_SESSION1_DEL com.syclo.sap.bapi.RemoteUserDeleteBAPI=/SYCLO/ CORE_MDW_SESSION1_DEL com.syclo.sap.bapi.RemoteUserUpdateBAPI=/SYCLO/ CORE_MDW_SESSION_UPD com.syclo.sap.bapi.TransactionCommitBAPI=WFD_TRANSACTION_COMMITAgentry App Development51 56. Agentry App Developmentcom.syclo.sap.bapi.SignatureCaptureBAPI=/SYCLO/ CS_DOBDSDOCUMENT_CRT13. Save and close the file to the installation location of the Agentry Server. With the completion of this procedure the JavaBe.ini configuration file for the Agentry Server is created, with settings to connect to the SAP system for which the mobile application will be developed.Installing the Agentry SDK Prerequisites The following items must be addressed prior to performing this procedure: This SDK is provided for development purposes and it is assumed the person installing these components understands the development of ActiveX controls, and/or inter process communications in Windows Mobile environments. If such items are not needed for your implementation, then this SDK need not be installed and is not needed for any other mobile application development using the Agentry Editor or other components of the SAP Mobile SDK. This SDK should be installed to the location where needed for development work; i.e. onto the same host system as the IDE or other development toolset to be used for development; or to a file share or network drive accessible to these tools.Note: The Agentry ActiveX API should be considered a deprecated resource. It is provided for backwards compatibility and will not be functionally changed in the future. Existing implementations making use of ActiveX can be migrated to the latest SAP Mobile Platform version without modification to the ActiveX controls in use. For new implementations in which custom controls are to be created, see the information provided on the OpenUI API for theAgentry Client. Task This procedure provides the steps for installing the Agentry SDK, which can be found in the SAP Mobile SDK package provided on the SAP Service Marketplace. This is a simple installation procedure, consisting of executing the installation program and selecting the location for the files within the Agentry SDK. Once the SDK has been installed, the resulting files are found in two distinct folders within the base installation location you will select: Agentry ActiveX Agentry External ProcessFor details on the contents of this SDK, and how to develop applications or controls using this SDK, see the Developer Guide: Agentry Applications, specifically the information beginning in the section The Agentry SDK, and the subsequent sections Technical Overview -52SAP Mobile Platform 57. Agentry App Development ActiveX Controls and the Agentry Client and Agentry Client API for External Processes Technical Overview. 1. Launch the installer program by executing Agentry_7.0.x.x_SDK.exe. (NOTE: x will vary depending on the service pack version currently available). 2. Click the Next button on the first screen Welcome to the Agentry Software Development Kit Setup Wizard. 3. Click the Yes button to accept the license agreement presented on the License Agreement screen. 4. Next specify the location where you would like the resources of the SDK to be installed in the Choose Install Location screen. 5. Click Install to install the Agentry SDK. Finish the wizard when prompted by the last screen, With the completion of this procedure the resources of the Agentry SDK have been installed. These resources can be moved or copied to other locations as needed and can be included in development projects. Next If you have not done so already, review the information provided on the Agentry SDK found in the Developer Guide: Agentry Applications.Developing Agentry Apps Use the Agentry Toolkit to develop metadata-driven applications.Eclipse Preferences for the Agentry Editor Plug-In With the release of version 5.2 of the Agentry Mobile Platform, additions have been made to the Eclipse preference pages by the Agentry Editor plug-in. These preferences affect the behavior of the Editor as a whole, or the appearance and behavior of the various views within the Agentry Perspective. The following sections detail each of these new preference pages. To access these pages, select the menu item Window | Preferences in Eclipse. In the Preference screen, select the Agentry root node on the left side of the screen. Compare Preferences The Compare Preferences page displays the preferences for the Comparison Views appearance. the settings provided allow for the personalization of the colors used to denote the definitions when in different states within this view. There is also a preference for the number of previous revisions to display when the local project is connected to a share repository. For each of the color preferences, the foreground and background color can be set by selecting the desired color from a color palette. The foreground color setting specifies the text color andAgentry App Development53 58. Agentry App Development the background color specifies the field behind the item. The following is a list of each of these preferences: Selected Definitions: This preference specifies the color scheme for the currently selected definition in the Comparison View. Matching Definitions: This preference specifies the color scheme for definitions