Back Forward More about Binary File rules
 

  1. About 
  2. New 
  3. Main 
  4. History 
  5. More... 

Binary file rules are one form of static content — rules that do not depend on clipboard values. When you save this form or check in a binary file rule, PRPC deletes any previous file on the Web server corresponding to the rule name and the RuleSet and version.

The first time a requestor asks for this file (for example, with <IMG SRC= > HTML reference), PRPC extracts the file from the rule into an appropriate Web server directory. The directory name is based on a hash code derived from the requestor's RuleSet list. Later requests are served directly from the file system.

Images

Standard binary file rules define the appearance of icons and navigation elements (such as ) on the harness forms for work items in your application. You cannot modify the standard rules, but you can override them with your images of the same size if you choose. This approach doesn't requiring finding or overriding the HTML references to the images.

pegaruleslogo.gifFor example, you can override the Designer Studio home image (logo_metal.gif) with your company or application logo. Copy the standard rule and upload a replacement GIF that is 81 pixels wide and 46 pixels tall.

Use the Image Library landing page (Pega Button > User Interface > Image Library) to review the images stored in binary file rules.

CautionWhen you use the Save As toolbar operation to copy a text file rule that contains CSS styles into a different RuleSet, a warning appears if the CSS text references images (that is, binary file rules) that are not available to you. Note the names of these images and copy or create them into your application RuleSet.

Flow diagram images

When you save a flow rule, the system automatically creates a related binary file rule containing the JPG image of the Visio or Process Modeler flow diagram. These rules support the initial display of static flow diagrams on the Diagram tab of the Flow form. To save storage space, the system does not retain history for these generated flows. The latest version of the diagram image is contained in the rule, overriding any older image.

Internal representation

When you upload a binary file into this rule, the system converts and stores it internally in a Base64 format. Oracle and Microsoft SQL Server can process this value in an endian-independent, character-set independent way. When extracted or downloaded, PRPC reconverts the file to its original format.

Automatic extraction and HTTP serving

When a requestor session first requests this binary object, PRPC extracts the image file from the rule into an appropriate Web server directory on the server. It determines the destination directory from the second key part of the rule, the RuleSet and version, and the Use latest version checkbox. If an older copy of the file exists, the older copy is overwritten.

Later HTTP requests for the same binary object (and the same RuleSet and Version) are served from the directory copy, for fast response.

NoteBrowsers use a workstation cache of recently received files. By default, PRPC marks static content such as images to remain in the cache for 24 hours. To make a newly updated or overridden binary file rule containing an image reach users, you can do any of the following:

<env name="http/defaultcachingtimeout" value="6000" />

A lower value causes more HTTP traffic and so can adversely affect response time.

As an alternative to the prconfig.xml file, you can use Dynamic System Settings to configure your application.
See How to create or update a prconfig setting.

Clearing the static files cache to re-extraction

If authorized, you can use the System Management application to delete all extracted static files from the HTTP server directory structure (on a specified node), forcing them to be extracted again on demand.

  1. Select > System > Tools > System Management App to start the System Management application.
  2. Select a node.
  3. Select Advanced > ETier Static Content Management from the System Management application menu.
  4. Click the  Delete Rule-File and ServiceExport   button.

JSP tag

The binaryfile JSP tag allows a binary file to be included in a stream sent to the browser through the static JSP tag.

Definitions ActiveX control, base64 encoding, binary file, static content
Related topics About HTML rules
About HTML Fragment rules

About the System Management application
binaryfile JSP tag
How to change the splash image and log-in form
Include JSP tag
User Interface category — Image Library page
About the Rules Inspector tool
Understanding ActiveX Controls and PRPC
Standard rules Atlas — Standard binary file rules

UpAbout Binary File rules