This article describes the API used to develop client plug-ins, as well as client-side form scripts.

For more information, refer to the client API documentation.

scope.api

The API is available by using scope.api.<moren>

scope.api.router

It only contains the function get(), which returns the Angular router.

scope.api.clipboard

The clipboard consists of an array of DMS objects and the type of clipboard action.

There are two action types available using the const "ClipboardAction":

ClipboardAction.COPY

ClipboardAction.CUT

scope.api.clipboard.set()

Use this function to set DMS objects and action type.

elements

DmsObject[]

action

ClipboardAction

scope.api.clipboard.get()

This function returns a clipboard object with elements and action.

scope.api.clipboard.clear()

This function clears the clipboard.

scope.api.events

Events can be triggered by a component. Listening components can then react.

Type of events

There are several client-specific events. The most common ones are bundled in the const "EnaioEvent".

LOGOUT

CLIENT_LOCALE_CHANGED

SCHEMA_LOCALE_CHANGED

DMS_OBJECT_DELETED

DMS_OBJECT_VERSION_RESTORED

DMS_OBJECT_FAVORITE_ON

DMS_OBJECT_FAVORITE_OFF

DMS_OBJECT_UPDATED

DMS_OBJECT_PASTED

DMS_OBJECT_VERSION_RESTORED

EO_DIALOG_STACK_CHANGED

scope.api.events.trigger()

With this function, you can trigger an event of the type mentioned above.

...

To update the process file list, use this trigger:

scope.api.events.trigger("eo.process.file.changed",[{
	id:'BD5DEF6896D842219719CEEBF8BC355A',
	title: "Hello Again",
	description: "Hello Again from Horst",
	iconid: "8ED1E037E4D7468AB69EB8A04C2EA080",
	creator: "root",
	addtime: "2021-07-09T09:19:40.047+0000",
	type: "qdoc"
}]);

scope.api.events.on()

With this function, you can listen to events of a type mentioned above.

Returns an Observable observable containing type and data.

scope.api.events.on(eo.dms.object.updated).subscribe(event => {
	let dmsObject = event.data;
	let eventType = event.type;
});

scope.api.session

Currently, only the following session function is available.

scope.api.session.getUser() (user information)

The function scope.api.session.getUser() returns the user object, in which the following properties about the currently logged-in user are available. They are read-only.

Functions

Sample script:

// Write information for the current user in a model value
// The model value must be a STRING type.
var u=scope.api.session.getUser(); 
scope.model.text.value=
'- Login name				\n'+u.name+'\n'+
'- Roles					\n'+u.roles.join()+'\n'+
'- Hasrole FULL_ACCESS?		\n'+u.hasRole('FULL_ACCESS');

scope.api.util

A list of helper functions follows:

sopce.api.util.translate

Returns the translated value for a specific translation key.

var myText = scope.api.util.translate('my.translation.key'); // myText = 'Example Text'

sopce.api.util.notifier (display messages)

This helper can be used to display messages in the form of a toaster. 

Functions

Example

var scope.api.util.notifierm=scope.model;
m.unlimited.onchange=function() {
	if( m.unlimited.value ) {	
		scope.api.util.notifier.success( 
			 m.firstname.value +' ' +m.familiyname.value+' is now employed without time limit.',		// Message
			'Personal information changed'   // optional: use a short title
		);
	}
}

The success message is displayed in green.

scope.api.util.encodeFileName

Encodes a file name safe for sending characters beyond ASCII-7bit using quoted printable encoding.

More information to come.

scope.api.http

You can use HTTP requests to get data from any service of the system, including custom microservices, which are part of the yuuvis® RAD microservice infrastructure.

The following standard functions are supported: get, post, put and delete.

...

If you want a format different from JSON, you have to add a third parameter {responseType: 'arraybuffer' | 'blob' | 'json' | 'text'}.

Remark: The handling of async HTTP requests must be done using 'then' because 'await' is currently not supported.

scope.api.http.get

// 1st example: show some user´suser's inbox workitemswork items in the message box:
scope.api.http.get('/get?size=10','/inboxservice').then(
	function(result) {
	    var inbox='';
		result.data.content.forEach(function(row) {
			inbox+=row.title+'</br>';
		});
		scope.api.util.notifier.success(inbox,'Some inbox workitemswork items');
	},
	function(error) {
		scope.api.util.notifier.error('Failed to load inbox', 'Error');
	}
);


// 2nd example: show all users' favorites
scope.api.http.get('/service/user/favorites','/rest-ws').then(
	function(result) {
	    var favs='';
		result.data.forEach(function(row) {
			favs+=row.title+'</br>';
		});
		scope.api.util.notifier.success(favs,'Your favorites');
	},
	function(error) {
		scope.api.util.notifier.error('Failed to load favorites', 'Error');
	}
);

// For more information, see the REST function descriptions.

scope.api.http.put

// how to change object data
var objectId = '7B683C8E19BD492198F6A262D14EF43F';
var changeBody = {'status': 'active'};
scope.api.http.put('/service/dms/'+objectId, changeBody, '/rest-ws').then(
	function(result){
		scope.api.util.notifier.info('Status changed to "active"', 'Success');
	},
	function(error){
		scope.api.util.notifier.error('Failed to change object data for ' + objectId, 'Error');
	}
);

// For more information, see the REST function descriptions.

scope.api.http.del

// how to delete an object until version 8.16 LTS
var objectId = '7B683C8E19BD492198F6A262D14EF43F';

scope.api.http.del('/service/dms/' + objectId, '/rest-ws').then(
	function(result) {
	    scope.api.util.notifier.info('Deleted object ' + objectId, 'Success');
	},
	function(error) {
		scope.api.util.notifier.error('Failed to delete object ' + objectId, 'Error');
	}
);

// Forhow to moredelete information,an seeobject thebeginning RESTwith functionversion descriptions.

scope.api.http.post

// how to create a subscription
var objectId = '7B683C8E19BD492198F6A262D14EF43F';
var body = {subject: 'My subscription', type: 'document'};
9.0
// the new parameter forceDelete=true must be used if objects that are contained in a process file should be deleted nevertheless

scope.api.http.postdel('/service/dms/subscription/' + objectId, body + '?forceDelete=true', '/rest-ws').then(
	function(result) {
		    scope.api.util.notifier.info('CreatedDeleted subscriptionobject for ' + objectId, 'Success');
	},
	function(error) {
		scope.api.util.notifier.error('Failed to createdelete subscriptionobject for ' + objectId, 'Error');
	}
);

// For more information, see the REST function descriptions.

scope.api.

...

This section describes the read access to object information.

scope.api.dms.getObject()

Loads a DMS object from the backend

...

http.post

// example:how getto objectcreate of a given IDsubscription
var objectId = '7B683C8E19BD492198F6A262D14EF43F';
var body = {subject: 'My subscription', type: 'document'};


scope.api.dmshttp.getObject(objectIdpost('/service/dms/subscription/' + objectId, body, '/rest-ws').then(
	function(result) {
		scope.api.util.notifier.info(result.title, 'Title of Object');
		// index-values can be found in result.data
		// example: result.data.companyname
	'Created subscription for ' + objectId, 'Success');
	},
	function(error) {
		scope.api.util.notifier.error('Failed to create subscription for ' +error objectId, 'An error occuredError');
	}
);

// For more information, see the REST function descriptions.

scope.api.dms

...

This section describes the read access to object information.

scope.api.dms.getObject()

Fetch Loads a DMS objects object from the server by search parametersbackend.

This functions uses the DMS-Service search.

...

...

// example: get object of a given ID
var objectId = '7B683C8E19BD492198F6A262D14EF43F';
scope.api.dms.getObject(objectId).then(
	function(result) {
		scope.api.util.notifier.info(result.title, 'Title of Object');
		// index-values can be found in result.data
		// example: result.data.companyname
	},
	function(error) {
		scope.api.util.notifier.error(''+error, 'An error occured');
	}
);

scope.api.dms.getResult()

Fetch DMS objects from the server by search parameters.

This functions uses the DMS-Service search.

This function returns a promise which is resolved by an array of DmsObjects matching the given parameters.

// fill dynamic list with object values
var dynlist = scope.model.catalogfield;
var myRequest={};
if ( scope.situation == 'CREATE' ) { 
	 myRequest={create:true};
}
if ( scope.situation == 'EDIT' ) {
	 myRequest={edit:true};
}
scope.api.dms.getResult(myRequest,'dynlist').then( 
	function(result) {
		var dynlist = [];
		result.forEach(function(row) {
			if( row.data.value ) {
				dynlist.push({
					value: row.data.value,
					description: row.data[scope.api.session.getUser().userSettings.schemalocale]
				});
			};
		});
		dynlist.setList({
			config: {
				allelementsselectable: true
			},
			entries: dynlist
		});
	},
	function(error) {
		scope.api.util.notifier.error('Could not values',error);
	}
);

scope.api.dms.downloadContent()

This function starts a download of the content file of a DMS object.

scope.api.config

Gets information about configurations.

scope.api.config.get()

This function returns information about the location of special resources.

scope.api.

...

agent

These functions help to handle custom actions with yuuvis® RAD agent.

scope.api.agent.getAvailability()

This function gets the agent availability and returns a promise which is resolved with the agent availability.

For examples, see the Client-side Custom Action Scripting documentation.

scope.api.agent.executeAction()

This function executes an action on a connected and paired client computer. For the format of the args parameter, see below.

...