Add Image File Screen

Creates a custom image file in Page Builder to use on your custom pages.

Figure: Add Image File Screen

Add Image File Screen

Prerequisites

How to Start

  1. Click Page Builder.

    Build Pages
  2. On the Home screen, in the left pane, click Library Library icon.

    Click Library
  3. In the left pane, click Images.

    Click Images
  4. On the Images screen, click Add Image.

    Add Image

Fields

Field NameDefinition

Display Name

Description:
Specifies the name of the image to create for your custom page.
Allowed Values:
One line of text (a string).

Accepted:

  • Letters
  • Numbers
  • Spaces
Default Value:
None

Internal Name

Description:
Specifies a unique, technical name for the image.

When you click on this field, the field shows the internal name by default. You can also specify a custom internal name. After the internal name is created, you can not change it.

Allowed Values:
One line of text (a string) that can have letters and numbers, and can not have spaces or special characters. Hyphens (-) and periods (.) are accepted.
Default Value:
None

Description

Description:
Specifies an optional text description for the image.
Allowed Values:
More than one line of text.
Default Value:
None

Image Source

Description:
Specifies whether to select an image from your local machine to create in the library in Page Builder.
Allowed Values:
  • Image From Local Storage - You can select an image from your local machine.
  • URL - Specifies the absolute URL or relative URL for an image.
Default Value:
Image From Local Storage

Select Image

Description:
Specifies the image file to create in the library.
To Open this Field:
  1. In the Image Source field, click Image From Local Storage.
Allowed Values:
An image file from your local machine.

Click the Browse button to select an image file from your local machine.

The file can be one of these types:

  • .png
  • .jpg
  • .jpeg
  • .gif
  • .tif
Default Value:
None

URL

Description:
Specifies the absolute URL of an image file to create in the library.
To Open this Field:
  1. In the Image Source field, click URL.
Allowed Values:
One line of text (a string) in URL format that points to an image file.

The file can be one of these types:

  • .png
  • .jpg
  • .jpeg
  • .gif
  • .tif
Default Value:
None
Example:
  • https://mysite.com/demo/image/upload/Sample.jpg
  • /library/images/ap-logo.jpg
Limitations:
  • These requirements apply to images that use an absolute URL:
    • Images must be stored in a web server or cloud storage location accessible through HTTPS that AgilePoint NX can access.
    • Images cannot be stored on a local file system, such as your local machine or the AgilePoint Server machine.
    • Images must be referenced with an absolute URL.
  • These requirements apply to images that use a relative URL:
    • You must specify the file path for the relative URL in this format:

      /library/images/[file name with the extension]

    • You can use the relative URL only if you know the image file name. If you do not know the file name, you can use the Image Library option on the Image Source field to select an image from the image library.

      For more information, refer to Images screen

      .
    • The image file must exist in the image library in Page Builder. To add an image to the Image Library, refer to Add Image File screen.
    • Support for relative URLs is available in these releases:
  • .jpeg and .tif format files are permitted, and .bmp format files are not permitted in these releases:

Add

Description:
Creates an image file for your custom pages.