Page Comparison

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

...

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

scope.api.router

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

...

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()

...

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

EO_DIALOG_STACK_CHANGED

scope.api.events.trigger()

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

scope.api.events.trigger(EnaioEvent.DMS_OBJECT_UPDATED, dmsObject);

...

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

Returns an Observable containing type and data.

...

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

Following are some A list of helper functions .follows:

sopce.api.util.translate

Returns the translated value for a specific translation key.

...

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
		);
	}
}

...

scope.api.util.encodeFileName

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

...

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

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

...

// 1st example: show some user´s inbox workitems 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 workitems');
	},
	function(error) {
		scope.api.util.notifier.error('Failed to load inbox', 'Error');
	}
);


// 2nd example: show all user´susers' 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.

...

// how to create a subscription
var objectId = '7B683C8E19BD492198F6A262D14EF43F';
var body = {subject: 'My subscription', type: 'document'};


scope.api.http.post('/service/dms/subscription/' + objectId, body, '/rest-ws').then(
	function(result){
		scope.api.util.notifier.info('Created subscription for ' + objectId, 'Success');
	},
	function(error){
		scope.api.util.notifier.error('Failed to create subscription for ' + objectId, 'Error');
	}
);

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

scope.api.dms

This section describes the read access to object information.

scope.api.dms.getObject()

Loads a DMS object from the backend

// 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');
	}
);

...

Fetch DMS objects from the server by search parameters.

This functions uses the DMS-Service search search.

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

...

This function starts a download of the content file of a dms 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 (version 4.0)

These functions help to handle custom actions with enaio yuuvis® 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.

...

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

Examples

scope.api.agent.executeAction(scope.api.agent.action.OPEN, { document: { id: myObject.id, title: myObject.title, type: myObject.type }, lock: false });

scope.api.agent.executeAction(scope.api.agent.action.MAIL, objectList.map(o => { return { id: o.id, title: o.title, type: o.type } }));

scope.api.agent.executeAction(scope.api.agent.action.EXTERNAL, { executable: 'jump2sap.exe', args: [ '/ID', myObject.id ] });

...