UIN Script Service

Last modified by Admin on 2017/11/27 00:04

brickScript service to generate incremental unique identification numbers
TypeXAR
CategoryAPI
Developed by

Denis Gervalle

Active Installs5
Rating
Rate!
0 Votes
LicenseGNU Lesser General Public License 2.1
Installable with the Extension Manager

Description

This extension exposes a simple script service that generate incremental unique identification number.

The service is thread-safe and store the last returned UIN into a configuration object in order to be resistant over server restarts.
You can define the value of the last generated number, and of the next increment from the UIN Script Service configuration in the administration of your wiki.

This is a per wiki extension. Since it installs a script service through a wiki component, you should have programming rights on your wiki to install this extension.

Don't confuse this extension with the Unique Identification Number Module which provides more advanced features, but with a high price in performance costs.

UINScriptServiceConfig.png

Usage from scripts

To retrieve a new Unique Identification Number in velocity:

  $services.uin.next

To update safely the UIN configuration, use:

  $services.uin.updateConfig(currentUIN, newUIN, increment)

If the current UIN does not match the actual current when the update is applied, the update will be cancelled with a ConcurrentModificationException.

Tested on

This extension has been tested with the following configurations.

Extension VersionXWiki FlavorNotes
1.0XWiki Enterprise 8.4.4

Expected to be usable starting with 6.4.4 but untested

Prerequisites & Installation Instructions

We recommend using the Extension Manager to install this extension (Make sure that the text "Installable with the Extension Manager" is displayed at the top right location on this page to know if this extension can be installed with the Extension Manager). Note that installing Extensions when being offline is currently not supported and you'd need to use some complex manual method.

You can also use the following manual method, which is useful if this extension cannot be installed with the Extension Manager or if you're using an old version of XWiki that doesn't have the Extension Manager:

  1. Log in the wiki with a user having Administration rights
  2. Go to the Administration page and select the Import category
  3. Follow the on-screen instructions to upload the downloaded XAR
  4. Click on the uploaded XAR and follow the instructions
  5. You'll also need to install all dependent Extensions that are not already installed in your wiki

Dependencies

Dependencies for this extension (org.xwiki.contrib:api-uin-scriptservice 1.1):

Tags:
Created by Denis Gervalle on 2017/01/24 23:44
    

Get Connected