Interfejs API języka JavaScript na potrzeby tworzenia usługi personelu po stronie klienta
W celu uzyskania dodatkowych informacji na temat zmiennych systemowych JavaScript po stronie klienta, które są dostępne w programie do projektowania dla programowania usług personelu po stronie klienta, należy zapoznać się z poniższa informacjami.
Zmienne te są zapełniane, gdy jest uruchamiana usługa personelu po stronie klienta, i odzwierciedlają stan systemu z tego momentu. Te zmienne nie są przeznaczone do zaktualizowania w usłudze personelu po stronie klienta.
Dodatkowe dane systemowe są dostępne po wywołaniu usługi, która pobiera odpowiednie zmienne systemowe, i zwróceniu ich ponownie do usługi personelu po stronie klienta.
Ograniczenie: Należy pamiętać, że wszystkie tw.* podane w poniższej tabeli dotyczą tylko skryptów JavaScript usługi personelu po stronie klienta i nie można ich używać w skryptach formatek i widoków, w tym we wstawianych skryptach JavaScript widoku, w dołączanych skryptach widoku, w definiowanych przez użytkownika skryptach zdarzenia widoku, w przypadku widoczności określanej na podstawie skryptu, w zdarzeniach instancji widoku itd. Kod JavaScript związany z formatkami działa w kontekście środowiska
wykonawczego formatek, który różni się od kontekstu usługi personelu po stronie
klienta, przez co nie może uzyskać dostępu do obiektu tw dostępnego
tylko w kontekście usługi personelu po stronie klienta.
| Zmienny | Opis |
|---|---|
| tw.constants.ECMServerNames | Nazwy serwerów, które mogą być używane w krokach integracji treści. |
| tw.constants.ECMServerNames.IBM_BPM_CONTENT_STORE | Nazwa serwera składnicy treści. |
| tw.constants.ECMServerNames.IBM_BPM_DOCUMENT_STORE | Nazwa serwera dla składnicy dokumentów. |
| tw.env | Przestrzeń nazw na potrzeby uzyskiwania dostępu do wartości zmiennych środowiskowych z kontekstu, w którym wywołano usługę personelu po stronie klienta. Zmienna musi być połączona z usługą personelu po stronie klienta. |
| tw.env.toolkit | Przestrzeń nazw na potrzeby uzyskiwania dostępu do wartości zmiennych środowiskowych z kontekstu określonej biblioteki narzędziowej. Zmienna środowiskowa zdefiniowana w bibliotece narzędziowej musi być połączona z usługą personelu po stronie klienta. |
| tw.epv | Przestrzeń nazw na potrzeby uzyskiwania dostępu do wartości zmiennych EPV z kontekstu, w którym wywołano usługę personelu po stronie klienta. Wartość EPV musi być połączona z usługą personelu po stronie klienta. |
| tw.epv.toolkit | Przestrzeń nazw na potrzeby uzyskiwania dostępu do wartości zmiennych EPV z kontekstu określonej biblioteki narzędziowej. Zmienna EPV zdefiniowana w bibliotece narzędziowej musi być połączona z usługą personelu po stronie klienta. |
| tw.błąd | Przestrzeń nazw, która udostępnia informacje o ostatnim wychwyconym błędzie. |
| tw.błąd.code | Kod ostatniego wychwyconego błędu. |
| tw.błąd.data | Dane dotyczące ostatniego wychwyconego błędu, które można odwzorować na zmienną lokalną. |
| tw.error.message | Komunikat informujący o błędzie, który wystąpił. Aplikacja lub autor usługi personelu po stronie klienta może zdecydować o wyświetleniu tego komunikatu z formatki dla użytkownika końcowego. |
| tw.resource.nazwa_lrname.właściwość | Przestrzeń nazw na potrzeby uzyskiwania dostępu do zasobów lokalizacji w skryptach JavaScript usługi personelu po stronie klienta. W
podanej składni nazwa_zasobu_lokalizacji jest nazwą zasobu lokalizacji, a właściwość jest nazwą właściwości. Na przykład tw.resource.LR1.ant
generuje translację właściwości ant w zasobie lokalizacji LR1. |
| tw.system.coachUtils.getLocallyChangedVars() | Zwraca tablicę zawierającą nazwy zmiennych, które zmieniły się w formatce od czasu jej uruchomienia. Ta metoda ma zastosowanie tylko wtedy, gdy jest używana w procedurze obsługi zdarzeń zmiany danych. |
| tw.system.coachUtils.hasLocallyChangedInputVars() | Zwraca wartość true, jeśli wartości zmiennych wejściowych zmieniły się w formatce od czasu jej uruchomienia. Ta metoda ma zastosowanie tylko wtedy, gdy jest używana w procedurze obsługi zdarzeń zmiany danych. |
| tw.system.coachUtils.hasLocallyChangedOutputVars() | Zwraca wartość true, jeśli wartości zmiennych wyjściowych zmieniły się w formatce od czasu jej uruchomienia. Ta metoda ma zastosowanie tylko wtedy, gdy jest używana w procedurze obsługi zdarzeń zmiany danych. |
| tw.system.coachUtils.hasLocallyChangedPrivateVars() | Zwraca wartość true, jeśli wartości zmiennych prywatnych zmieniły się w formatce od czasu jej uruchomienia. Ta metoda ma zastosowanie tylko wtedy, gdy jest używana w procedurze obsługi zdarzeń zmiany danych. |
| tw.system.coachValidation | Wyniki sprawdzania poprawności dla zmiennych, które są powiązane z widokami w formatce tej usługi personelu po stronie klienta. |
| tw.system.coachValidation.addValidationError(variableName, errorMessage) | Dodaje komunikat o błędzie dla powiązanej zmiennej do listy błędów sprawdzania poprawności. Jeśli lista zawiera już komunikat dla zmiennej nazwa_zmiennej, ten komunikat zostanie zastąpiony.
|
| tw.system.coachValidation.clearValidationErrors() | Usuwa wszystkie błędy sprawdzania poprawności z listy. |
| tw.system.coachValidation.populateFromBOSaveFailedError(boSaveFailedError) | Wyodrębnia komunikaty o błędzie dla każdej właściwości w danym błędzie błąd_niepowodzenia_zapisywania_obiektu_biznesowego i dodaje je do listy błędów sprawdzania poprawności. Jeśli istnieje wiele komunikatów sprawdzania poprawności dla konkretnej właściwości, używany jest ostatni z listy. |
| tw.system.coachValidation.removeValidationError(variableName) | Usuwa błąd sprawdzania poprawności dla podanej nazwy zmiennej, jeśli ten błąd istnieje. |
| tw.system.coachValidation.updateValidationErrorMessage(variableName, errorMessage) | Aktualizuje błąd sprawdzania poprawności w przypadku nazwy zmiennej, dla której jest udostępniany nowy komunikat o błędzie.
|
| tw.system.coachValidation.validationErrors | Lista błędów sprawdzania poprawności dla zmiennych powiązanych. Aktualizacje listy muszą być wykonane za pomocą funkcji tw.system.coachValidation. |
| tw.system.dataChangeUtils | Funkcje programu narzędziowego, które są używane na potrzeby pracy z aktualizacjami danych z serwera. Ta metoda ma zastosowanie tylko wtedy, gdy jest używana w procedurze obsługi zdarzeń zmiany danych. |
| tw.system.dataChangeUtils.applyAllIncomingVars() | Stosuje do klienta wartości wszystkich zmiennych zaktualizowanych na serwerze. Ta metoda ma zastosowanie tylko wtedy, gdy jest używana w procedurze obsługi zdarzeń zmiany danych. |
| tw.system.dataChangeUtils.applyIncomingVar(variableName) | Stosuje do klienta wartość zmiennej zaktualizowanej na serwerze. Ta metoda ma zastosowanie tylko wtedy, gdy jest używana w procedurze obsługi zdarzeń zmiany danych. |
| tw.system.dataChangeUtils.getIncomingVars() | Zwraca obiekt zawierający zmienne z wartościami zaktualizowanymi na serwerze, które nie zostały jeszcze zastosowane do klienta. Ta metoda ma zastosowanie tylko wtedy, gdy jest używana w procedurze obsługi zdarzeń zmiany danych. |
| tw.system.processApp | automatyzacja przepływu pracy lub biblioteka narzędziowa, która zawiera usługę personelu po stronie klienta. |
| tw.system.processApp.akronim | Akronim automatyzacji przepływu pracy lub przybornika, który zawiera usługę personelu po stronie klienta. |
| tw.system.processApp.id | Identyfikator automatyzacji przepływu pracy lub biblioteki narzędziowej, która zawiera usługę personelu po stronie klienta. |
| tw.system.processApp.nazwa | Nazwa automatyzacji przepływu pracy lub biblioteki narzędziowej, która zawiera usługę personelu po stronie klienta. |
| tw.system.processApp.obraz stanu | Wersja automatyzacji przepływu pracy lub biblioteki narzędziowej, która zawiera usługę personelu po stronie klienta. |
| tw.system.processApp.obraz stanu.id | Identyfikator automatyzacji przepływu pracy lub biblioteki narzędziowej wersja , która zawiera usługę personelu po stronie klienta. |
| tw.system.processApp.snapshot.nazwa | Nazwa automatyzacji przepływu pracy lub biblioteki narzędziowej wersja , która zawiera usługę personelu po stronie klienta. Ta zmienna ma zastosowanie tylko wtedy, gdy wersja jest nazwą wersja. |
| tw.system.processInstance | Instancja procesu, w której działa ta usługa personelu po stronie klienta. Ta zmienna ma zastosowanie tylko wtedy, gdy usługa personelu po stronie klienta działa w instancji procesu. |
| tw.system.processInstance.atRiskData | Data, po upływie której ta instancja procesu zostanie uznana za zagrożoną zaległością. Data jest udostępniana jako obiekt Date języka JavaScript. |
| tw.system.processInstance.caseFolderId (nieaktualne) | Nieaktualne. Zamiast niego należy użyć processInstanceFolderId. Identyfikator folderu powiązanego z instancją procesu, w której działa ta usługa personelu po stronie klienta. Ta zmienna ma zastosowanie tylko wtedy, gdy usługa personelu po stronie klienta działa w instancji procesu. |
| tw.system.processInstance.caseFolderServerName (nieaktualne) | Nieaktualne. Zamiast niego należy użyć processInstanceFolderServerName. Nazwa serwera powiązanego z instancją, w której działa ta usługa personelu po stronie klienta. |
| tw.system.processInstance.dueDate | Data, do której ta instancja procesu ma zostać zakończona. Data jest udostępniana jako obiekt Date języka JavaScript. |
| tw.system.processInstance.processInstanceFolderId | Identyfikator folderu sprawy powiązanego z instancją procesu. Zastępuje nieaktualną zmienną caseFolderId. |
| tw.system.processInstance.processInstanceFolderServerNazwa | Nazwa serwera powiązanego z folderem sprawy instancji procesu. Zastępuje nieaktualną zmienną caseFolderServerName. |
| tw.system.processInstance.id | Identyfikator instancji procesu, w której działa usługa personelu po stronie klienta. |
| tw.system.processInstance.nazwa | Nazwa instancji procesu, w której działa usługa personelu po stronie klienta. |
| tw.system.processInstance.parentCase.caseId | Identyfikator sprawy nadrzędnej powiązany z instancją procesu. |
| tw.system.processInstance.parentCase.caseServerId | Identyfikator serwera powiązanego z instancją sprawy nadrzędnej. Nieprzeznaczony do prezentowania użytkownikom końcowym. |
| tw.system.processInstance.parentCase.parentActivityId | Identyfikator działania nadrzędnego powiązanego z instancją procesu. |
| tw.system.processInstance.proces | Proces instancji procesu, w której działa usługa personelu po stronie klienta. |
| tw.system.processInstance.process.opis | Opis procesu instancji procesu, w której działa usługa personelu po stronie klienta. |
| tw.system.processInstance.process.nazwa | Nazwa procesu instancji procesu, w której działa usługa personelu po stronie klienta. |
| tw.system.processInstance.processApp | Automatyzacja przepływu pracy lub biblioteka narzędziowa, która zawiera instancję procesu, w której działa ta usługa personelu po stronie klienta. |
| tw.system.processInstance.processApp.akronim | Akronim automatyzacji przepływu pracy lub przybornika, który zawiera instancję procesu, w której działa ta usługa personelu po stronie klienta. |
| tw.system.processInstance.processApp.id | Identyfikator automatyzacji przepływu pracy lub biblioteki narzędziowej, która zawiera instancję procesu, w której działa ta usługa personelu po stronie klienta. |
| tw.system.processInstance.processApp.nazwa | Nazwa automatyzacji przepływu pracy lub biblioteki narzędziowej, która zawiera instancję procesu, w której działa ta usługa personelu po stronie klienta. |
| tw.system.processInstance.processApp.snapshot | Wersja automatyzacji przepływu pracy lub biblioteki narzędziowej, która zawiera instancję procesu, w której działa ta usługa personelu po stronie klienta. |
| tw.system.processInstance.processApp.snapshot.id | Identyfikator automatyzacji przepływu pracy lub biblioteki narzędziowej wersja , która zawiera instancję procesu, w której działa ta usługa personelu po stronie klienta. |
| tw.system.processInstance.processApp.snapshot.nazwa | Nazwa automatyzacji przepływu pracy lub biblioteki narzędziowej wersja , która zawiera instancję procesu, w której działa ta usługa personelu po stronie klienta. Ta zmienna ma zastosowanie tylko wtedy, gdy wersja jest nazwą wersja. |
| tw.system.processInstance.startDate | Data uruchomienia instancji procesu. Data jest udostępniana jako obiekt Date języka JavaScript. |
| tw.system.processInstance.startingDocumentId | Identyfikator dokumentu uruchamiającego instancję procesu, w której działa dana usługa personelu po stronie klienta. |
| tw.system.processInstance.startingDocumentServerName | Nazwa serwera zawierającego dokument uruchamiający instancję procesu, w której działa dana usługa personelu po stronie klienta. |
| tw.system.processInstance.zadanie | Zadanie w instancji procesu, w której działa usługa personelu po stronie klienta. |
| tw.system.processInstance.task.atRiskData | Data, po upływie której to zadanie zostanie uznane za zagrożone zaległością. Data jest udostępniana jako obiekt Date języka JavaScript. |
| tw.system.processInstance.task.dueDate | Data, do której to zadanie ma zostać zakończone. Data jest udostępniana jako obiekt Date języka JavaScript. |
| tw.system.processInstance.task.enablingDocumentId | Identyfikator dokumentu włączającego instancję procesu, w której działa dana usługa personelu po stronie klienta. |
| tw.system.processInstance.task.enablingDocumentServerName | Nazwa serwera zawierającego dokument włączający działanie zadania użytkownika w procesie implementowanym przez daną usługę personelu po stronie klienta. |
| tw.system.processInstance.task.id | Identyfikator zadania w instancji procesu, w której działa usługa personelu po stronie klienta. |
| tw.system.processInstance.task.narrative | Opisowa narracja dla zadania w instancji procesu, w której działa ta usługa personelu po stronie klienta. Narracja jest widoczna w aplikacji Workplace. |
| tw.system.processInstance.task.originator | Nazwa użytkownika, który utworzył to zadanie. Jest to poprzedni właściciel zadania lub użytkownik, który uruchomił instancję procesu. |
| tw.system.processInstance.task.właściciel | Nazwa użytkownika przypisanego do tego zadania. |
| tw.system.processInstance.task.priorytet | Priorytet zadania podawany jako wartość typu łańcuchowego. Może on przyjmować jedną z następujących wartości: Lowest (najniższy), Low (niski), Normal (normalny), High (wysoki), Highest (najwyższy). |
| tw.system.processInstance.task.priorityValue | Priorytet zadania podawany jako liczba całkowita. Może on przyjmować jedną z następujących wartości: 50, 40, 30, 20, 10. |
| tw.system.processInstance.task.processActivity | Opis działania procesowego powiązanego z zadaniem. |
| tw.system.processInstance.task.processActivityNazwa | Nazwa działania procesowego powiązanego z zadaniem. |
| tw.system.processInstance.task.startDate | Data rozpoczęcia zadania. Data jest udostępniana jako obiekt Date języka JavaScript. |
| tw.system.processInstance.task.startingDocumentId | Identyfikator dokumentu uruchamiającego instancję procesu, w której działa dana usługa personelu po stronie klienta. |
| tw.system.processInstance.task.status | Status zadania podawany jako łańcuch. |
| tw.system.processInstance.task.subject | Opisowy temat zadania w instancji procesu, w której działa ta usługa personelu po stronie klienta. Temat jest widoczny w aplikacji Workplace. |
| tw.system.url.bpmDataPunkt końcowy | Punkt końcowy usługi REST, który jest używany do pobierania danych związanych z zadaniami, panelami kontrolnymi, procesami i usługami możliwymi do uruchomienia. |
| tw.system.url.userInfoPunkt końcowy | Punkt końcowy usługi REST, który jest używany do udostępniania informacji z profilu użytkownika (takich jak awatar, nazwa stanowiska itp.). Patrz Obiekt kontekstu widoku formatki. |
| tw.system.użytkownik | Właściciel zadania w procesie implementowanym przez tę usługę personelu po stronie klienta. W przeciwnym razie użytkownik, który zainicjował usługę personelu po stronie klienta. |
| tw.system.użytkownik.baseTextKierunek | Zmienna sterująca kierunkiem tekstu. Jest używana do obsługi języków dwukierunkowych. |
| tw.system.użytkownik.fullName | Pełna nazwa właściciela zadania, jeśli ta usługa personelu po stronie klienta działa w instancji procesu. W przeciwnym razie pełna nazwa użytkownika, który zainicjował usługę personelu po stronie klienta. |
| tw.system.użytkownik.id | Identyfikator właściciela zadania, jeśli ta usługa personelu po stronie klienta działa w instancji procesu. W przeciwnym razie identyfikator użytkownika, który zainicjował usługę personelu po stronie klienta. |
| tw.system.użytkownik.ustawienia_narodowe | Ustawienia narodowe użytkownika określone w preferencjach użytkownika. Ta wartość jest udostępniana jako łańcuch. |
| tw.system.użytkownik.localeDescription | Czytelny opis ustawień narodowych użytkownika. |
| tw.system.użytkownik.zarządza | Tablica zespołów zarządzanych przez danego użytkownika. |
| tw.system.użytkownik.zarządza [ i].id | Identyfikator zespołu zarządzanego przez danego użytkownika. |
| tw.system.użytkownik.zarządza [ i].nazwa | Nazwa zespołu zarządzanego przez danego użytkownika. |
| tw.system.użytkownik.zarządza [ i].tkShortName | Akronim biblioteki narzędziowej zespołu, którym zarządza dany użytkownik. |
| tw.system.użytkownik.nazwa | Nazwa właściciela zadania, jeśli ta usługa personelu po stronie klienta działa w instancji procesu. W przeciwnym razie nazwa użytkownika, który zainicjował usługę personelu po stronie klienta. |
| tw.system.użytkownik.zespoły | Tablica zespołów, do których należy użytkownik. |
| tw.system.użytkownik.zespoły [ i].id | Identyfikator zespołu, do którego należy dany użytkownik. |
| tw.system.użytkownik.zespoły [ i].nazwa | Nazwa zespołu, do którego należy dany użytkownik. |
| tw.system.user.teams [ i].tkShortName | Akronim biblioteki narzędziowej zespołu, do którego należy dany użytkownik. |