Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.
Comment: Published by Scroll Versions from space WADMINPAS and version 24.1
Multiexcerpt include
SpaceWithExcerptINTERNAL
MultiExcerptNamekubernetes_only
PageWithExcerptINTERNAL:_admin_portal_excerpts

Administrators can manage the settings of an xUML service in section Configuration in the service details view. With PAS 24.0 it is also possible to define global variables. This allows to use the same setting value in various - or all - xUML services of your PAS installation.

If you want to create or manage global variables, click Global Variables in the navigation bar:

Overview on the Global Variables View

The global variables view consists of two sections:

Image Removed

  1. Navigation Bar: From the navigation bar you can...

  2. Global Variables List: The list shows all available global variables. Use the list to...

Image Added

Global PAS Variables

Every PAS installation comes with some global standard variables. These variables are ready to use, but they cannot be adapted or deleted. The following standard variables are provided:

Global PAS VariableDescription
PASGlobalKeycloakBasePathProvides the base path added to the Keycloak host to connect to your realm.
PASGlobalKeycloakDefaultXUMLClientIDProvides the default Keycloak Client-ID used in the xUML services.
PASGlobalKeycloakHostProvides the hostname of the Identitiy Management (Keycloak) used in PAS.
PASGlobalKeycloakURLProvides the URL of the Identitiy Management (Keycloak) used in PAS.
PASGlobalMongoDBReplicaSetProvides the name of the replica set used in the MongoDB of PAS.

Global Variables History Log

Below the the global variables view, a history log is displayed showing the date and time when a user has made changes to a global variable:

Image Added

The global variables history log is a read-only view that supports users to keep track of all changes that have been made to the global variables.

Image Added

Use the filter field to search for a global variable change.

The content of the filter field is applied to column Action.

Image Added

Click Extended filter Image Added to display the extended filter options:

  • Action
  • User
  • Reset Filter

If a filter is applied, the extended filter changes to Image Added.

Image Added

Multiexcerpt include
SpaceWithExcerptINTERNAL
MultiExcerptNamexuml_services_change_config_filter_reset
PageWithExcerptINTERNAL:_admin_portal_excerpts

Creating a Global Variable

Click Add New Variable to create a new global variable.

In the pop-up, enter the necessary content:

ValueDescription
Name

Enter a name for your global variable. Variable names must be unique. If a variable name already exists, you will get a corresponding error message.

Tip
titleExpert Advice

Define a standard notation before creating your first global variable.
As a best practice, we recommend using upper camel case, e.g. MyGlobalVariable .

Type

Select a type for your variable. Available types are:

  • string
  • number
  • boolean
  • password
  • datetime
ValueEnter the value of your globale global variable.
DescriptionEnter a meaningful description for your global variable.

Click Apply to create the global variable.

Editing a Global Variable

You can adjust value and description of a created global variable at any time.

Edit the content directly in the global variables' list.

Save is only enabled when changes have been made.


The counter on top right indicates if and how many changes have been made.

Click Save to open the Manage Variables dialog.

It shows all changes you have just made. The old and the new value are displayed so that you can check your changes again.

New values are only applied after a service restart.
If the variable is already in use, you have the option of restarting all - or selected - services directly.
Select the services you want to restart in the displayed list.

Info

Please note: If you deselect the automatic restart for some services at this point, you will not receive any further notification later that these services need to be restarted manually.

Click Save to save your changes and restart the selected services.

You can edit several variables at once.
All changes will be displayed in the Manage Variables dialog.

Info

If you click Cancel to abort the action, the changed content is still displayed in the list. If you leave the list without saving, the old values will be shown when you reopen the global variables' list the next time.

Deleting a Global Variable

To delete a global variable, click .

Confirm the security prompt in the pop-up window to delete the variable from the list.

Info

You can only delete unused global variables. If a global variable is still in use, the option is not available. Either detach the global variable from the service (by defining a temporary new service-specific variable) or delete the service.

Image Added

Every PAS installation provides some global standard variables.
These variables are read-only and cannot be deleted.

...