Creating URL Links to Sage X3 Functions in Visual Processes

The visual process editor is a component that can be used to:

• Draw pictures and their background
• Create links to other pages by defining links on elements

You can define most links in the visual process editor using a specific link type in the link dialog opened from an element’s toolbar, but you can also create links by using the URL link type. You need to follow some rules to create the relevant URL according to the type of link you want to generate.

In this blog post, we’ll review how to code URL links to Sage X3 functions.

Links to X3 functions (class and representation mode)

A link is defined by a class, a representation, a facet, and, optionally, a key. The classes and representations are defined in the corresponding dictionaries in Sage X3.

When the key is not specified, the URL is formatted as follows: $baseUrl}/CLASS?representation=REPRESENTATION.$facet

With CLASS being the class code, REPRESENTATION being the representation code, and $facet being the facet ($query).

When the key is specified, the URL is formatted as follows: {$baseUrl}/CLASS(‘key_value’)?representation=REPRESENTATION.$facet

With CLASS being the class code, key_value being the key value, REPRESENTATION being the representation code, and $facet being the facet ($details or $summary).

If the key value is based on several components, values are separated by a tilde (~).

Here are a few examples:

• Access to the query for a representation and a class (TABCONTAINER, for example)
  {$baseUrl}/TABCONTAINER?representation=TABCONTAINER.$query

• Access to the detail of a table definition (the entity is ATABLE, and the key is BPCUSTOMER)
  {$baseUrl}/ATABLE(‘BPCUSTOMER’)?representation=ATABLE.$details

• Access to the summarized view of a cost accounting dimension (the key is the dimension type and the dimension)
  {$baseUrl}/CACCE(‘CCT~COMM-001’)?representation=CACCE.$summary

For more information on creating URL links for Sage X3 functions in visual processes, please check out the Sage X3 Online Help Center or contact us.