Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

Table of Contents
location
maxLevel4
minLevel4
locationtop
styleborder:1
toptypeflat
separatorpipe

...

The table Element

...

Some types of fields can have optional attributes. A The text-area field accepts height and width as optional attributes. The height and width attributes should be numerical and their values should be in pixels. The text field accepts url as an optional attribute. Setting url="true" displays the text as a URL instead of as a plain text box.

...

This is the root element of the new artifact which is being defined. It has several attributes:

  • type - Defines the media type of the artifact. The type format should be application/vnd.[SOMENAME]+xml. SOMENAME can contain any alphanumeric character, "-" (hyphen), or "." (period).

    Info

     Use the following pattern when defining the media type of custom RXTs:  application/[a-zA-Z0-9.+-]+

  • shortName - Short name of the artifact. Only lower case characters are allowed in the short name. This value cannot be modified once the RXT is added into the WSO2 Governance Registry.
  • singularLabel - Singular label of the artifact
  • pluralLabel - Plural label of the artifact
  • hasNamespace - Defines whether the artifact has a namespace (boolean)
  • iconSet - Icon set number used for the artifact icons

...

Info

You cannot have the (~!@#;%^*()+={}|\<>"',) characters in the value of the unique fields that are defined in the storagePath element in the RXT. Hence, you need to add a validation for the field definitions of those fields. For example, consider the following storage path.

Code Block
languagexml
<storagePath>/gadgets/@
{overview_provider}
/@
{overview_name}
/@
{overview_version}
</storagePath>

The validations required for the following storage path are as follows:

Code Block
languagexml
...............
<content>
<table name="Overview">
<field type="text" required="true">
<name>Provider</name>
</field>
<field type="text" required="true" validate="^([a-zA-Z0-9_\s\-]*)$">
<name>Name</name>
</field>
........................
Note

When choosing attributes for the storagePath of an RXT, choose attributes, which have unique and static values. Also, mark those fields as read-only since you should not change the values of them after creating the asset.

Code Block
languagexml
titleExample:
<field type="text" required="true" readonly="true">
<name>Provider</name>
</field>
<field type="text" required="true" readonly="true" validate="^([a-zA-Z0-9_\s\-]*)$">
<name>Name</name>
</field>

...

The nameAttribute Element

Code Block
<nameAttribute>details_name</nameAttribute>

...