3.1 Methoden
- Team Dodo
- Technische Redaktion
Die DMS-Eigenschaft des 'formHelper'-Objekts hat Funktionen, mit denen Standard-DMS-Aktionen ausgeführt werden können. Diese DMS-Aktionen werden asynchron ausgeführt und müssen mit Callbacks versehen werden. Bei allen DMS-Aktionen wird die Objekttyp-ID des Dokuments benötigt, um Performance zu sparen. Bei allen DMS-Aktionen werden die Objekttyprechte des Benutzers für die einzelnen Objekttypen ausgewertet.
- 1 formHelper.dms.delete({item})
- 2 formHelper.dms.insert({item})
- 3 formHelper.dms.update({item})
- 4 formHelper.dms.moveItem({objectId}, {targetId}, {sourceId}, {objectTypeId}, {targetTypeId})
- 5 formHelper.dms.addLocation({objectId}, {targetId}, {objectTypeId}, {targetTypeId})
- 6 formHelper.dms.getLocations({objectId}, {objectTypeId}, {queryObjectData})
- 7 formHelper.dms.search({query}, {queryConfig})
- 8 formHelper.dms.searchById({osid})
- 9 formHelper.dms.searchDistinctValues({query})
- 10 formHelper.dms.openLocation({inNewTab},{objectId}, {objectTypeId}, {parentId}, {parentTypeId})
- 11 formHelper.dms.openIndexData({inNewTab},
- 12 {mode},{objectId}, {objectTypeId})
- 13 formHelper.dms.openResultList({inNewTab}, {query}, {title}, {description}, {useAsIni}, {executeDefaultAction})
- 14 formHelper.dms.openResultListByIds({inNewTab}, {items}, {title}, {description}, {executeDefaultAction})
API-Methode | Verfügbar ab | Offline | Beschreibung |
|---|---|---|---|
formHelper.dms.delete({item}) | 8.50 Final | NEIN | Um Dokumente zu löschen, muss der 'delete'-Funktion ein Objekt mit der OSID und der Objekttyp-ID übergeben werden. Beispiel var item = {
objectTypeId : 17,
osid : 14019
};
// fire and forget version of delete
formHelper.dms.delete(item)
// version with callbacks when delete job is finished, either success or error
formHelper.dms.delete(item).then(function() {
console.log("Do whatever You want after the document was deleted")
},
function(error) {
console.log(error) // something went wrong :(
}); |
formHelper.dms.insert({item}) | 8.50 Final | NEIN | Um Dokumente im DMS anzulegen, werden mehrere Informationen benötigt:
Beispiel: var insert = {
targetId : 14019,
objectTypeId : 196620,
fields : {
bnr: "0815", // assignment of value through internal name
photograph: "DemoUser",
date: "01.02.2015", // see the remark under this example
grid: [ // grids need to be an array of rows
["1","2"], // row 1
["3","4"], // row 2
["5","6"] // row 3
]
}
};
formHelper.dms.insert(insert).then(function(response) {
// the response contains the osid of the item that was created (e.g { id : "1234" })
console.log("success")
},function(error) {
console.log(error)
});Datum und Zeit Ab enaio 10.0 Final verwenden Sie bitte ISO Datums- und Datum/Zeit Formate und nicht wie oben dargestellt ein sprachabhängiges Format. |
formHelper.dms.update({item}) | 8.50 Final | NEIN | Um Indexdaten zu ändern, werden folgende Informationen benötigt:
Beispiel: var update = {
osid: 12496,
objectTypeId: 196620,
fields: {
bnr: "0815", // assignment of value through internal name
photograph: "DemoUser",
date: "01.02.2015", // see the remark under this example
grid: [ // grids need to be an array of rows
["1","2"], // row 1
["3","4"], // row 2
["5","6"] // row 3
]
}
};
formHelper.dms.update(update).then(function(response){
console.log("success")
},function(error) {
console.log(error)
});Datum und Zeit Ab enaio 10.0 Final verwenden Sie bitte ISO Datums- und Datum/Zeit Formate und nicht wie oben dargestellt ein sprachabhängiges Format. |
formHelper.dms.moveItem({objectId}, {targetId}, {sourceId}, {objectTypeId}, {targetTypeId}) | 8.50 SP2 | NEIN | Um ein Dokument oder Register zu verschieben, werden folgende Informationen benötigt: Parameter:
Optionale Parameter:
Beispiel: var objectId = "18757";
var targetId = "1893";
var sourceId = "1234";
var objectTypeId = "234";
var targetTypeId = "21";
formHelper.dms.moveItem(objectId, targetId, sourceId, objectTypeId, targetTypeId).then(function(){
console.log("success");
},function(error){
console.log(error);
}); |
formHelper.dms.addLocation({objectId}, {targetId}, {objectTypeId}, {targetTypeId}) | 8.50 SP2 | NEIN | Um einen Standort zu einem Dokument hinzuzufügen, werden folgende Informationen benötigt:
Nur Dokumente können mehrere Standorte haben, Ordner und Register dagegen nicht. Beispiel: var objectId = "18757";
var targetId = "1893";
var objectTypeId = "234";
var targetTypeId = "21";
formHelper.dms.addLocation(objectId, targetId, objectTypeId, targetTypeId).then(function(){
console.log("success");
},function(error){
console.log(error);
}); |
formHelper.dms.getLocations({objectId}, {objectTypeId}, {queryObjectData}) | 8.50 SP2 | NEIN | Um alle Standorte eines Dokumentes zurückgegeben zu bekommen, wird nur die OSID des Dokumentes benötigt. Man bekommt eine Liste von Pfaden zurück, welche die Standorte des Dokuments ausgehend von der jeweils obersten Ebene beschreibt.
Beispiel: var objectId = "18869";
var objectTypeId = "262208";
formHelper.dms.getLocations(objectId, objectTypeId).then(function(locationList){
console.log(locationList);
},function(error){
console.log(error);
}) |
formHelper.dms.search({query}, {queryConfig}) | 8.50 Final | NEIN | Führt eine Standardsuche über enaio® app-connector aus. Tiefergehende Informationen zur DMS-Suche finden Sie im Handbuch "OS_AppConnector" auf dem Installationsmedium oder ab der Version 9.10 im Dokumentationsportal unter Installation bzw. Administration. Parameter:
Rückgabe: Der Searchaufruf liefert ein Array von dmsDocument-Objekten zurück. Beispiel: var query = {
"query": {
"objectTypeId": "262220",
"fields": {
"Vertragsbasis": {
"value": "1"
},
"Archivbeleg erzeugen": {
"value": "1"
}
},
"result_config": {
"fieldsschema": [{
"internalName": "id"
}, {
"internalName": "Vertragsbasis"
}]
}
}
};
formHelper.dms.search(query).then(function(response){
console.log(response)
}, function(error){
console.log(error)
});Weitere Informationen zum Anfragesyntax entnehmen Sie bitte der API-Dokumentation von enaio® app-connector. |
formHelper.dms.searchById({osid}) | 8.50 Final | NEIN | Sucht nach dem Dokument mit der passenden OSID. Rückgabe: Die Suche nach ID liefert ein dmsDocument. Beispiel:formHelper.dms.searchById(1337).then(function(response){
console.log(response)
}, function(error){
console.log(error)
}); |
formHelper.dms.searchDistinctValues({query}) | 8.50 Final | NEIN | Die Suche nach verschiedenen Werten. Die Suchparameter sind ähnlich der Standardsuche. Parameter:
Optionale Parameter:
Rückgabe: Die Suche liefert ein Array von Werten. Beispiel: var query = {
objectTypeId : "196620",
requestFields : [{
internal : "Photograph",
value : "mein*"
}],
responseFields : ["Photograph"]
};
formHelper.dms.searchDistinctValues(query).then(function(response){
console.log(response)
}, function(error){
console.log(error)
}); |
formHelper.dms.openLocation({inNewTab}, | 8.50 SP2 | NEIN | Öffnet einen Standort für ein Dokument, Register oder Schrank. Hat ein Dokument mehrere Standorte, kann über 'parentId' und 'parentTypeId' angegeben werden, welcher Standort geöffnet werden soll. Soll nicht der Standort eines Registers, sondern das Register geöffnet werden, können 'objectId' und 'objectTypeId' leer gelassen werden und die ID und die Objekttyp-ID des Registers als 'parentId' und 'parentTypeId' übergeben werden. Die Parameter für die Objekttyp-IDs sind optional, tragen jedoch erheblich zur Performanz bei, wenn sie gesetzt sind. Ist ein Objekttyp-ID-Parameter nicht gesetzt, wird dieser vom Client selbst ermittelt. Ist der Parameter gesetzt aber nicht valide, wird eine Fehlermeldung in der Entwicklerkonsole des Browsers ausgegeben. Wenn mehr als eine Tab per Script geöffnet werden soll (mehrere Standorte), dann muss auf den Clients im jeweiligen Browser der Pop-up-Blocker für die Domain deaktiviert werden. Andernfalls wird nur der erste Standort in einem neuen Tab geöffnet und alle weiteren sind blockiert. Parameter:
Optionale Parameter:
Beispiel: // den Standort eines Dokuments öffnen
var objectId = "39374";
var objectTypeId = "234";
var inNewTab = true;
formHelper.dms.openLocation(inNewTab, objectId, objectTypeId).then(function() {
console.log("success");
}, function(error) {
console.log(error);
});
// einen bestimmten Standort eines Dokuments mit mehrere Standorten öffnen
var objectId = "39374";
var objectTypeId = "234";
var parentId = "3758";
var parentTypeId = "14";
var inNewTab = true;
formHelper.dms.openLocation(inNewTab, objectId, objectTypeId, parentId, parentTypeId).then(function() {
console.log("success");
}, function(error) {
console.log(error);
});
// ein Register öffnen (nicht den Standort des Registers)
var parentId = "3758";
var parentTypeId = "14";
var inNewTab = true;
formHelper.dms.openLocation(inNewTab, null, null, parentId, parentTypeId).then(function(){
console.log("success");
}, function(error) {
console.log(error);
});Diese Skripting-Methode wird durch die Methode "/wiki/spaces/WEB/pages/21269711" der Dashlet API aufgerufen. |
formHelper.dms.openIndexData({inNewTab},{mode},{objectId}, {objectTypeId}) | 8.50 SP3 | NEIN | Öffnet die Indexdatenmaske zu einem ECM-Objekt über dessen OSID wahlweise im Editiermodus oder im schreibgeschützten Modus und in einem neuen Browsertab oder im selben Browsertab. Parameter:
Optionale Parameter:
Beispiel: var inNewTab = false;
var mode = "view";
var objectId = "23619";
var objectTypeId = "196620;
var success = formHelper.dms.openIndexData(inNewTab, mode, objectId, objectTypeId);
if (success) {
console.log("success");
} else {
console.log("error");
}Diese Skripting-Methode wird durch die Methode "/wiki/spaces/WEB/pages/21269689" der Dashlet API aufgerufen. |
formHelper.dms.openResultList({inNewTab}, {query}, {title}, {description}, {useAsIni}, {executeDefaultAction}) | 8.50 SP5 | NEIN | Öffnet die Trefferliste zu einer gegebenen Suchanfrage in einem neuen Browsertab oder im selben Browsertab. Parameter:
Optionale Parameter:
Beispiel: var query = {
"query": {
"objectTypeId": "262171",
"fields": {
"Text0": {
"value": "*li*"
}
},
"result_config": {
"fieldsschema": [{"internalName": "datum1"}, {"internalName": "feld2"}, {"internalName": "feld3"}],
"pagesize": 200,
"offset": 0,
"maxhits": 200
}
}
};
formHelper.dms.openResultList(false, query, "MyTitle", "MyDescription").then(function() {
console.log("ok");
}, function() {
console.log("error");
}); |
formHelper.dms.openResultListByIds({inNewTab}, {items}, {title}, {description}, {executeDefaultAction}) | ab 9.10 SR1 | NEIN | Öffnet die Trefferliste für die angegebene Liste von (osid,objectTypeId) Paaren. Parameter:
Optionale Parameter:
Beispiel: const items = [
{ "osid": "393", "objectTypeId": "0" },
{ "osid": "19595", "objectTypeId": "0" }
];
formHelper.dms.openResultListByIds(false, items, "MyTitle", "MyDescription", true)Indirekte Nutzung in der Adressleiste:
|