Enabling rich text fields on PWA screens by running a utility

As a developer, you add rich-text capabilities to PWA screens to provide application users with the ability to add formatted text and images. Instead of manually opening each form and updating the fields by using Developer Studio, you can run the Enable ARTF for PWA utility that automatically converts the PWA screens to create and accept rich text. The Enable ARTF for PWA utility saves you time and effort and helps avoid human error when you manually try to convert fields to accept rich text.

The Enable ARTF for PWA utility updates the following ticket types to support rich text:

  • Help Desk
  • Change
  • Work Order


Related topics

Enabling-rich-text-field-on-Progressive-Web-Application-screens

Scenario

In Apex Global, the application users are unable to format text and add screenshots to the incidents they are creating. Seth wants to convert all the character fields in the application to accept rich text but does not want to manually open each field in Developer Studio and then convert it to support rich text. Instead, Seth runs a command line utility that converts all PWA screens to support rich text fields.

Before you begin

  • You must contact support to obtain the Enable ARTF for PWA utility. 
    BMC Support Central

  • You must have administrator rights on the server where you run the utility.

To enable rich text fields on PWA screens by running a utility

  1. Open the command prompt.
  2. Navigate to the folder where you saved the Enable ARTF for PWA utility.
  3. Run the following command:
    enableartfforpwa.bat -x <serverName> -u <user> -t <tcpport> -rollback false
    (linux) enableartfforpwa.sh -x <serverName> -u <user> -t <tcpport> -rollback false
    The utility creates a file result.htm within a subfolder named output. The file result.htm contains a report listing all the actions that were performed to support rich text and their status. The utility also creates log files within a subfolder named logs within the folder named output. 


To view the updated PWA screens

  1. Open the Cache Settings page in the MidTier - Configuration Tool.
    http://<MidtierHostName>:PortNumber>/arsys/shared/config/config_cache.jsp
  2. To flush the cache, click Flush Cache.
    A confirmation dialog box is displayed. 
  3. Click OK.
  4. In a browser, log in to PWA.
    (On-premises) http://<midtierHostName>:<portNumber>/arsys/pwa/#/login
    (SaaS) http://<helixBaseURL>/arsys/pwa/#/login
  5. Navigate to a ticket type, for example, Helpdesk, Change, or Work Order.
  6. Confirm that fields such as Activity allow formatting of text and adding images.


To roll back the changes made by the utility

To roll back the changes made by the Enable ARTF for PWA utility, perform the following steps:

  1. Open the command prompt.
  2. Navigate to the folder where you saved the utility.
  3. Run the following command:
    enableartfforpwa.bat -x <serverName> -u <user> -t <tcpport> -rollback true
    (linux) enableartfforpwa.sh -x <serverName> -u <user> -t <tcpport> -rollback true
    The utility creates a file result.htm which contains a detailed report of the status of rollback of all actions that were previously performed by the utility.

 

Tip: For faster searching, add an asterisk to the end of your partial query. Example: cert*