Configuring Applications In Maximo Mobile 8 DRAFT - IBM

1y ago
19 Views
5 Downloads
538.75 KB
10 Pages
Last View : 6d ago
Last Download : 2m ago
Upload by : Grady Mosby
Transcription

Configuring applications in Maximo Mobile for EAM You can configure a default Maximo Mobile for EAM application, such as, adding a new field to the Technician application, using Docker container technology and Maximo application framework tools. Maximo application framework tools are used to create a development environment within a Docker image on your local system. Download, modify application XML, test and publish your Maximo applications with minimal setup. Prerequisites A minimum of 8 GB RAM on the development system (16 GB recommended). Docker Desktop installed on your development system. (https://docs.docker.com/getdocker/). Ensure that your system meets all of the Docker Desktop requirements. Set the Memory Resources preference in Docker Desktop to 8 GB of memory. A working directory on your local system dedicated to development. API KEY enabled. Refer to Interfacing with REST apis using API keys and API Keys for more information. Reference information Component reference An IBM Maximo component reference (maf-component-docs-2.4.zip ) is included in the same location from which you downloaded the Maximo application framework tools Docker image. This information describes the properties and XML code of Maximo components that are included in Maximo Mobile for EAM applications. Unzip this file, change to the maf-component-docs folder and open the index.html file with your browser. Command variable legend The variables in the following table are used in examples throughout this document: Variable {maximo workspace directory} {maximo app name} {version} {Container-ID} Description The working directory that you create on your local system. The name of the Maximo application that you are configuring. For example, Inspections or Technician. The version of the Docker image. To use the most recent version of Docker, specify latest. The ID of the container. Use the docker ps command to list the containers that are currently running.

Configuration overview Configuring a Maximo Mobile for EAM application consists of the following steps: 1. 2. 3. 4. 5. Install Docker Desktop on your local development system. Download the Maximo application framework tools from the IBM Box repository. Create a credentials JSON file to connect to the production Maximo server. Download the application source files from the production Maximo server. Modify the application XML of the application. Note that configuration is limited to XML updates. Changes to any other application files such as Javascript files, is not supported. 6. Build the application. 7. View the updated application locally using React. 8. Upload the final build and publish it to the Maximo server. Configuration considerations Working directories Create multiple working directories for development, test, and production work on your local system when configuring a Maximo application. Copy the files you configure in your development directory to a test directory. After you verify your configuration in the test environment, copy files from the test directory to a production directory. You can then deploy the application from your local system to the production Maximo server. Each of these directories must have their own unique credentials file that is used to connect to individual development, test, and production Maximo servers. This approach helps avoid accidentally uploading changes to the wrong environment. Upgrade Configuring a Maximo Mobile for EAM application involves downloading application files to your local system as a Docker image, modifying the application XML, and then redeploying the application into your production environment. Automatic upgrade of configured application XML is not currently supported. Manually back up the current version of XML files for an application before you upgrade Maximo Mobile for EAM. If you do back up your files, your current configurations will be overwritten during the upgrade process. Save these files so you can reimplement your configurations after the upgrade. Application XML files are located in the src directory of the application file structure. For example, the Technician application XML files app.xml and wo-card-group.xml are located in the {maximo workspace directory}/TECHMOBILE/src directory.

Configuration tool capabilities in Maximo Asset Management 7.6.1.2 This version of Maximo Mobile for EAM configuration tooling enables updating of the application XML to change the display of data. Changing the display of data includes displaying existing and custom fields, changing and hiding labels, and repositioning data on a page. This version of the configuration tooling does not facilitate changes that would result in updates to the data that is saved in the Maximo database. Subsequent releases will enable and provide guidance for the support of data. Barcode formats Barcode formatting is determined by the value set for the readers property found in the app.xml file. The following values can be set for the readers property: ean reader (the default value) ean 8 reader code 128 reader code 39 reader code 39 vin reader code 93 reader codabar reader upc reader upc e reader i2of5 reader 2of5 reader To set the readers property, use the following format: readers ”code 128 reader” Date and time limitation In Maximo, a DATE field stores the DATE portion only. Time is set to 00:00:00 and the time zone is not considered. If you set a date of 2021-01-31T00:00:00 13:00 and someone else in a time zone of -05:00 reads that date, the date is still 2021-01-31, not 2021-01-30. The time zone plays no role. A TIME field stores the TIME portion of a DATE, and the actual date is not relevant. Again, the time zone plays no role. If you set a TIME of T02:00:00 13:00 and later read that time back in a -05:00 time zone, the time is T02:00:00-05:00. The time value does not evaluate the time

zone. The purpose of these two data types in Maximo is to set absolute DATE and TIME values that do not adjust across time zones. The DataFormatter class sets DATE and TIME values when formatting and parsing dates. If you are using UI components such as SmartInput, the DataFormatter will correctly get and set the DATE or TIME object, ignoring the TimeZone if it is specified. If you are manually setting a TIME or DATE field, or getting a DATE or TIME field from a datasource, use the DataFormatter API dateWithoutTimeZone(val). This API accepts an ISO8061 datetime string and returns an ISO8061 datetime string without a time zone. This approach allows the TIME value to be treated as local time without the time zone. Configuring actions for inspections You can define custom actions that are available to inspectors and inspector supervisors when they complete an inspection by using scripts. Refer to Configuring actions for inspections. It is important to note that you must use MXAPIINSPECTIONRES as the object structure for the integration script. Deploying the Maximo application framework tools Docker image on your local system 1. Download the latest version of the compressed Docker image to your working directory. (https://ibm.ent.box.com/folder/127977637583) 2. Start Docker Desktop on your system. 3. Open a command line and change directory to the location of the .tgz file that you downloaded. 4. Load the Maximo application framework tools Docker image into your local Docker instance: docker image load maf-tools- {version}.tgz so, for example, docker image load maf-tools-2.4.tgz Note that it is possible to run out of space that is allocated to Docker Desktop. This occurs when you have too many Docker containers deployed. Remove any Docker containers you no longer need from the Docker Desktop.

5. Confirm the Maximo application framework tools image was loaded correctly by listing Docker images. docker image ls You should see a Docker image that is named maximo/maf-tools. Creating a credentials JSON file Create a credentials file to authorize access to your production server. 1. Create a new file in your working directory and name it credentials.json. 2. Add information about the Maximo server and the user credentials you will use to access it. { "userName": "myname", "password": "mypass", "domain": " mydomain.xyz", "port": 8080 } Note that the Maximo application framework tools can use usernames and passwords or API keys to authenticate to the Maximo server, but not both. If you are using an API key to authenticate, do not include userName and password properties in the credentials file. { “apikey”: “pjf5f4u71njtcbi8rdg978pch64j3p8avk24sbr0",

"domain": " mydomain.xyz", "port": 8080 } API keys make REST API calls without requiring user credentials. When an API key is created for a Maximo user, API calls that are made using that API key effectively work in the context of the Maximo user. Refer to Interfacing with REST apis using API keys and API Keys for more information. Downloading the application from the Maximo server and extract the source Open a command line and change directory to the working directory that includes the credentials file that you created. Run the following Docker command to download an application from the production Maximo server and extract it on your local system. docker run -it --privileged --rm -v {maximo workspace directory}/:/graphite/app maximo/maftools: {version} download -a {maximo app name} So, for example, for the Technician application, docker run -it --privileged --rm -v e/app maximo/maftools:2.4 download -a TECHMOBILE Note that there are two spaces between app and maximo in the command. Application files that are extracted into your working directory appear similar to these examples for the Technician application.

Configuring the application Maximo Mobile for EAM applications can include several application XML files. Application XML files are located under the src folder. In the case of the Technician application, there are two files, app.xml and wo-card-group.xml. The wo-card-group.xml file is referenced in the app.xml file. Remember that configuring a Maximo Mobile for EAM application is defined as modifying existing presentation XML for an application. Configuring any other files, such as modifying a JavaScript file, is not supported. Common configurations include adding new fields to an application card, updating field labels, and adding a new card.

Whenever you are modifying an application component, refer to the Maximo component reference for details about properties, attributes, and elements. It is important that you update the credentials.json file located under the application directory with the same information you used to download the application from the production server. The credentials under the application directory are used to redeploy the application after you have configured it. Editing application XML files Backup any file before you edit them. It can be useful to make changes using an XML editor that will color-code XML syntax and allow you to expand or collapse XML element structures. For more information about editing application XML, and examples, refer to Configuring Maximo application XML. Running the application locally to confirm your changes In this step, you start up a React server in watch mode within the Docker container on our local system to verify the changes that you made to the application. This process will also build the application for you. Open a command line and change to the working directory that contains the root folder of the application files and also the credentials file. docker run -it --privileged --rm -v {maximo workspace directory}/ {maximo app name}/:/graphite/app -p 3002:3000 maximo/maf-tools: {version} start So, for example, for the Technician application: docker run -it --privileged --rm -v E/:/graphite/app p 3000:3000 maximo/maf-tools:2.4 start This command starts up a React server on port 3000 and loads and starts the Maximo application. Open a browser and enter localhost:3000 to view the application.

Creating a production build After you finish testing your changes locally, you create a production build of the application to upload to the Maximo server. Open a command line and change to the working directory that contains the root folder of the application files and also the credentials file. Run the following Docker command to run a production build of the application that includes the changes you made. docker run -it --privileged --rm -v {maximo workspace directory}/ {appName}/:/graphite/app maximo/maftools: {version} build:production So, for example, for the Technician application, docker run -it --privileged --rm -v E/:/graphite/app maximo/maf-tools:2.4 build:production Note that there are two spaces between app and maximo in the command. This command converts the application XML into a React application and puts it in the build/app directory. It also creates a React build to compile and distribute in the /build/app/build directory. Publishing the updated application to the Maximo server You are now ready to redeploy the newly configured application into the Maximo server. Open a command line and change to the build/app/build directory. Copy the credentials file into the same directory. Run the following Docker command to package and publish the production build. docker run -it --privileged --rm -v {maximo workspace directory}/ {maximo app name}/:/graphite/app maximo/maf-tools: {version} upload

So, for example, for the Technician application, docker run -it --privileged --rm -v aphite/app maximo/maf-tools:2.4 upload Note that there are two spaces between app and maximo in the command. This command publishes the production build zip file. Your configured application will now be available on the production Maximo server. Train field personnel After you have implemented your configured application, provide training or develop reference materials that can help your users leverage your new user interface features.

4. Load the Maximo application framework tools Docker image into your local Docker instance: docker image load maf-tools- {version}.tgz so, for example, docker image load maf-tools-2.4.tgz Note that it is possible to run out of space that is allocated to Docker Desktop. This occurs when you have too many Docker containers deployed.

Related Documents:

Using Maximo Data in Microsoft Project 1-4 IBM Maximo Adapter for Microsoft Project: User s Guide Creating a Project in Microsoft Project Using Maximo Data 1 In Maximo s Work Order Tracking or Preventive Maintenance application, create and save a query. 2 In Microsoft Project, open a new Maximo project. 3 In the Maximo for Project Startup dialog box, click New Maximo

Upon the successful completion of this course, the Maximo user will be able to: 1. Accurately and efficiently log into MAXIMO 7 2. Identify and Utilize Screen Form Conventions 3. Successfully navigate to any given Maximo Application or screen 4. Effectively query for Maximo Records

Upon the successful completion of this course, the Maximo user will be able to: 1. Accurately and efficiently log into MAXIMO 7 2. Identify and Utilize Screen Form Conventions 3. Successfully navigate to any given Maximo Application or screen 4. Effectively query for Maximo Records

Upon the successful completion of this course, the Maximo user will be able to: 1. Accurately and efficiently log into MAXIMO 7 2. Identify and Utilize Screen Form Conventions 3. Successfully navigate to any given Maximo Application or screen 4. Effectively query for Maximo Records

Configuring the adapter in Maximo Asset Management 1 1 You must configure the adapter in Maximo Asset Management to send transactional data between Maximo

architecture design & project management and has extensive experience in the following fields: – Maximo project management – Maximo customizations: Java class extensions and automation scripting – Integrations: web service, interface table, and flat file – New Maximo implementations, upgrades, and assessments

IBM Maximo Asset Navigator Portions ' 1993-2002 SnowboundŽ Software Corporation. RasterMasterŽ Raster imaging technology provided by Snowbound Software Corporation. IBM Maximo Mobile Portions ' 2005 DataMirror, Inc. Portions ' 2000-2005 Zaval Creative Engineering Group. IBM Maximo Mobile SE Portions ' 1996-2005 Syclo, LLC. Note

A user-friendly web-based package giving access to Maximo on mobile devices. Seamless transition from real-time to offline mode when a user's connection to the Maximo environment is lost. Product Features Full Maximo Functionality Work Order Management View Job Tasks and Safety Plans Inventory Tracking Issues and Transfers