agorum core docform - Entwicklung - Konfiguration

In diesem Dokument sind Informationen enthalten, um dieses Modul in die Benutzerumgebung eines Kunden einzubinden.

Home - Einbindung

Im Folgenden wird beschrieben, wie Sie das Modul im Home-Bildschirm integrieren.

Apps - URL

Es gibt unterschiedliche Möglichkeiten das Modul über eine URL aufzurufen:

agorum core smart assistant konfigurator

Nachfolgend wird beschrieben, wie Sie das Modul im agorum core smart assistant einbinden können.

Action - Einbindung

Eine allgemeine Beschreibung können Sie hier nachlesen: URL aus dem agorum core smart assistant aufrufen

Es werden die URLs aus dem Abschnitt "Apps - URL" dazu verwendet.

Beispiel im agorum core smart assistant als Client-Action:

/* global window, ids */ 

window.open('/roiwebui/docform_module/?train=' + ids[0]);

Bei dieser Client-Action wird für das markierte Dokument das agorum core docform - Training gestartet. Der Selektor sollte hier nur für Dokumente gelten, die einen docform Typ haben und ggf. noch weiter einschränkend auf ein Dokument sein. Ist bereits ein Training vorhanden ist, wird dieses direkt geladen. 

Ein Einsatz für diese Aktion wäre z.B. dass ein Training schnell für ein bestimmtes Dokument angepasst werden soll. Dazu muss das Dokument nur noch markiert werden und das Training kann starten.

Einbinden in agorum core aguila

In agorum core aguila wird die Einbindung indirekt über den agorum core smart assistant gemacht. Die Beschreibung finden Sie hier: JavaScript-Modul filingassistant-service

Beispiel: Hier wird die oben definierte Client-Action für das Object mit der ID '1223221' aufgerufen.

let service = require('filingassistant/service');
let objects = require('common/objects);
..
.
service.action('sample_aguila_asa_action_DocForm-Training' , [ objects.find('1223221') ]);

Hier ein Beispiel zum testen (die oben definierte Client-Action muss vorhanden sein):

let aguila = require('common/aguila');
let service = require('filingassistant/service');
let objects = require('common/objects');

let widget = aguila.create({
  width: 800,
  height: 80,
  type: 'agorum.composite.form.basic',
  name: 'basicForm',
  validation: [
    {
      required: true
    }
  ],
  elements: [
    {
      type: 'agorum.composite.form.element.objectPicker',
      name: 'pObject',
      label: 'Objektauswahl',
      displayProperty: 'anyFolderPath',       // UUID, name, ID, anyFolderPath
      valueProperty: 'UUID',                  // UUID, name, ID, anyFolderPath
      pickerType: 'search',                   // search, folder
      searchParameters: {                     // parameters for search
        additionalBaseQuery: 'docformtype:*'  // Nur Dokumente finden, 
      }                                       //  die schon durch docform durch sind
    },
    {
      type: 'agorum.hbox',
      items: [
        {
          type: 'agorum.spacer',
          flexible: true
        },
        {
          type: 'agorum.composite.form.element.button',
          name: 'btAsaAction',
          text: 'DocForm - Training',
          disabled: true
        },
        {
          type: 'agorum.spacer',
          flexible: true
        }
      ]
    }
  ]
});

let form = widget;
let pObject     = form.down('pObject');
let btAsaAction = form.down('btAsaAction');

form.on('validChanged', valid => {
  btAsaAction.disabled = !valid;
});

form.on('action', button => {
  if (button.name === 'btAsaAction') {
    aguila.fork(() => {
      console.log('value: ', pObject.value);
      return objects.find(pObject.value);
    })
    .then (obj => {
      console.log('obj: ' , obj.ID);
      service.action('sample_aguila_asa_action_DocForm-Training' , [ obj ]);
    });
  }
});

widget;

Hier gibts das Beispiel als zip-Installer zum installieren. Es wird empfohlen dieses auf einem Testsystem zu machen. Es wird das aguila-Script und ein agorum core smart assistant - AddOn installiert. Das Projket heits wie die zip-Datei. Installiert wird es durch den zip-Installer: undefined>sample.aguila.asa.action-1.0.0.zip

Allgemein gilt:

service.action(actionName <, objArray >);

Im agorum core smart assistant gibt es eine Action, deren interner Name im Parameter "actionName" steht. Wenn Sie ein Object mit übergeben, muss dieses in einem Array stehen, unabhängig davon, ob eine Client- oder Server-Action im agorum core smart assistant aufgerufen wird.