Nuta
Dostęp do tej strony wymaga autoryzacji. Możesz spróbować się zalogować lub zmienić katalog.
Dostęp do tej strony wymaga autoryzacji. Możesz spróbować zmienić katalogi.
Otwiera formularz encji lub formularz szybkiego tworzenia.
Składnia
Microsoft.CIFramework.openForm(entityFormOptions,formParameters).then(successCallback,errorCallback);
Parametry
| Name | Typ | Wymagane | Description |
|---|---|---|---|
| entityFormOptions (Opcje formularza) | Obiekt JSON | Tak | Opcje formularza encji służące do otwierania formularza. Obiekt zawiera następujące atrybuty: - Pasek poleceń cmdbar - createFromEntity (utwórz jednostkę) - identyfikator jednostki - entityName (nazwa_podmiotu) - identyfikator formularza -wysokość - Pasek nawigacyjny - openInNewWindow (otwórzInNewWindow) - pozycjaOkna - identyfikator procesu - processInstanceId (identyfikator instancji procesu) -związek - selectStageId (identyfikator etapu) - useQuickCreateForm (formularz użycia) -Szerokość Informacje o atrybutach można znaleźć w entityFormOptions tabeli obiektów . |
| formParameters (parametry formularza) | Object | Nie. | Obiekt słownika, który przekazuje dodatkowe parametry do formularza. Nieprawidłowe parametry spowodują błąd. Aby uzyskać informacje na temat przekazywania parametrów do formularza, zobacz Ustawianie wartości pól przy użyciu parametrów przekazywanych do formularza i Konfigurowanie formularza do akceptowania niestandardowych parametrów ciągu zapytania. |
| successCallback (pomyślne wywołanie zwrotne) | Funkcja | Nie. | Funkcja do wykonania, gdy operacja zakończy się pomyślnie. |
| errorOddzwanianie | Funkcja | Nie. | Funkcja do wykonania, gdy operacja zakończy się niepowodzeniem. |
entityFormOptions Atrybuty obiektu
W poniższej tabeli opisano atrybuty parametru entityFormOptions .
Uwaga / Notatka
Atrybuty są opcjonalne.
| Nazwa atrybutu | Typ | Description |
|---|---|---|
| Pasek cmdBar | logiczny | Wskazuje, czy ma być wyświetlany pasek poleceń. Jeśli ten parametr nie zostanie określony, pasek poleceń zostanie wyświetlony domyślnie. |
| createFromEntity | Szukaj | Wskazuje rekord, który będzie zawierał wartości domyślne na podstawie zmapowanych wartości atrybutów. Obiekt odnośnika ma następujące właściwości typu String: entityType, id, i name (opcjonalnie). |
| entityId | Sznurek | Identyfikator rekordu encji, dla którego ma być wyświetlany formularz. |
| entityName | Sznurek | Nazwa logiczna encji, dla której ma być wyświetlany formularz. |
| formId | Sznurek | Identyfikator instancji formularza, która ma zostać wyświetlona. |
| height | Number | Wysokość okna formularza do wyświetlenia w pikselach. |
| Pasek nawigacyjny | Sznurek | Określa, czy pasek nawigacyjny jest wyświetlany i czy nawigacja aplikacji jest dostępna przy użyciu obszarów i podobszarów zdefiniowanych na mapie witryny. Prawidłowe wartości to: on: Zostanie wyświetlony pasek nawigacyjny. Jest to zachowanie domyślne, navBar jeśli parametr nie jest używany. off: Pasek nawigacyjny nie jest wyświetlany. Użytkownik może nawigować za pomocą innych elementów interfejsu użytkownika lub przycisków Wstecz i Dalej. entity: W formularzu encji dostępne są tylko opcje nawigacji dla encji pokrewnych. Po przejściu do encji pokrewnej, na pasku nawigacyjnym wyświetlany jest przycisk Wstecz, który umożliwia powrót do oryginalnego rekordu. |
| openInNewWindow (otwórz w nowym oknie) | logiczny | Wskazuje, czy formularz ma być wyświetlany w nowym oknie. |
| PozycjaOkna | Number | Wskazuje położenie formularza w oknie. Prawidłowe wartości to: 1 dla pozycji środkowej i 2 dla pozycji bocznej. |
| processId (identyfikator procesu) | Sznurek | Identyfikator procesu biznesowego, który ma być wyświetlany w formularzu. |
| processInstanceId (identyfikator wystąpienia) | Sznurek | Identyfikator instancji procesu biznesowego, który ma być wyświetlany w formularzu. |
| relacja | Obiekt JSON | Wskazuje obiekt relacji, w którym mają być wyświetlane rekordy pokrewne w formularzu. Informacje o atrybutach można znaleźć w relationship tabeli obiektów . |
| selectStageId (identyfikator etapu) | Sznurek | Identyfikator wybranego etapu w instancji procesu biznesowego. |
| useQuickCreateForm (formularz użycia) | Number | Szerokość okna formularza do wyświetlenia w pikselach. |
relationship Atrybuty obiektu
W poniższej tabeli opisano atrybuty atrybutu relationship object entityFormOptions parametru.
Uwaga / Notatka
Atrybuty są opcjonalne.
| Nazwa atrybutu | Typ | Description |
|---|---|---|
| attributeName (nazwa_atrybutu) | Sznurek | Nazwa atrybutu używanego dla relacji. |
| nazwa | Sznurek | Nazwa relacji. |
| właściwość navigationProperty (wła | Sznurek | Nazwa właściwości nawigacji dla relacji. |
| Typ relacji | Number | Typ relacji. Prawidłowe wartości to: 0 dla relacji jeden-do-wielu i 1 dla relacji wiele-do-wielu. |
| roleType (typ roli) | Number | Typ roli w relacji. Prawidłowe wartości to: 1 dla odwołania i 2 dla AssociationEntity. |
Wartość zwracana
W przypadku powodzenia zwraca obiekt Promise zawierający ciąg znaków.
Example
Poniższy przykładowy kod otwiera nowy formularz zdarzenia ze wstępnie wypełnionymi wartościami dla niektórych pól, takich jak identyfikator kontaktu i opis.
var id = "5af02e2a-d0d1-e811-8158-000d3af97055"
var title = "Sample Case Form"
var entityFormOptions = {};
entityFormOptions["entityName"] = "incident";
var formParameters = {};
//pre-populate some fields based on the context
formParameters["title"] = title;
formParameters["customerid"] = id;
formParameters["customeridtype"] = "contact";
formParameters["caseorigincode"] = 1;
formParameters["description"] = "Opened the form with pre-populated details like title, contact id, and description.";
//Open the form
Microsoft.CIFramework.openForm(JSON.stringify(entityFormOptions), JSON.stringify(formParameters)).then(
function (success) {
console.log(success);
},
function (error) {
console.log(error);
}
);