Konfigurationsumgebungsvariablen für SMS Gateway

Sie können SMS Gateway konfigurieren, indem Sie Docker-Umgebungsvariablen definieren. Wo Sie die Umgebungsvariablen angeben, hängt davon ab, wo Sie das Gateway bereitstellen.

Die Dateien docker-compose.yml und deploy.json enthalten jeweils Beispiele zur Konfiguration der Umgebungsvariablen.

Multi-Tenant-JSON-Umgebung: Die Tenantkonfiguration wird in einer separaten JSON-Datei angegeben und gespeichert, die anschließend in der SMS Gateway-Konfiguration referenziert wird. Es wird nur die Konfiguration, die sich nicht auf einen Tenant bezieht, wie z. B. die Kernkonfiguration für die Bereitstellung, über die Docker-Umgebungsvariablen angegeben. Ausführliche Informationen darüber, welche Einstellungen in der JSON-Datei konfiguriert werden müssen, finden Sie unter Tenants in einer Multi-Tenant-JSON-Umgebung für SMS Gateway konfigurieren.

Umgebungsvariablen für die Kernkonfiguration für die Bereitstellung

In den folgenden Tabellen sind die Umgebungsvariablen aufgelistet, die Sie für die Konfiguration der SMS Gateway-Umgebung definieren können. Diese Werte werden in der gesamten Bereitstellung verwendet.

Allgemeine Konfiguration für die Bereitstellung

Umgebungsvariable Standardwert Beschreibung
MULTI_TENANT_CONFIG_FILE Nicht zutreffend Der Pfad zu einer JSON-Datei für die Konfiguration einer Multi-Tenant-JSON-Konfiguration.

Caching-Server konfigurieren

Hoch verfügbare Umgebungen erfordern die Konfiguration eines XSLD-Caching-Servers (IBM WebSphere eXtreme Scale Liberty Deployment) zum Speichern von Sitzungsstatus.

Tabelle 2. Umgebungsvariablen für die Konfiguration der Protokollierung und Traceerstellung
Umgebungsvariable Standardwert Beschreibung
XS_ENABLED false Setzen Sie den Wert auf true, um die Bereitstellung von SMS Gateway mit einem XSLD-Caching-Server zu aktivieren.
XS_CATALOG_ENDPOINTS Nicht zutreffend Eine durch Kommas getrennte Liste mit Endpunkten für alle Katalogserver im Datengrid im Format Host:Port. Beispiel: cat01.port.client:4809, 9.123.4.5:4809.
XS_USERNAME Nicht zutreffend Wichtig: Muss auf den Wert xsadmin, einem integrierten Administratorberechtigungsnachweis für den XSLD-Caching-Server, gesetzt werden.
XS_PASSWORD Nicht zutreffend Ein Kennwort für den XSLD-Container. Wenn Sie mehrere XSLD-Container bereitstellen, müssen Sie dasselbe Kennwort für jeden Container verwenden.
XS_TRANSPORT_TYPE TCP/IP Der Transporttyp zum Herstellen einer Verbindung zum XSLD-Container. Geben Sie für nicht gesicherte Verbindungen TCP/IP oder SSL-Required an, wenn SSL für alle Katalogserver konfiguriert ist.

Protokollierung und Traceerstellung konfigurieren

Tabelle 3. Umgebungsvariablen für die Konfiguration der Protokollierung und Traceerstellung
Umgebungsvariable Standardwert Beschreibung
ENABLE_TRANSCRIPTION_MESSAGES false Setzen Sie den Wert auf true, um Transkriptionsnachrichten zu aktivieren. Damit Transkriptionsnachrichten protokolliert werden können, muss der Wert für die Umgebungsvariable LOG_LEVEL auf finest gesetzt werden. Wenn diese Nachrichten aktiviert sind, werden sie in Protokolldateien ausgegeben. Beachten Sie, dass diese Nachrichten sensible PHI-, PII- und PCI-DSS-Daten enthalten können.
LATENCY_REPORTING_THRESHOLD 1000 Schwellenwert in Millisekunden für die Berichterstellung zur Umlauflatenzzeit des Watson Assistant-Service.
LOG_LEVEL info Die Detailgenauigkeit der Informationen, die in die Protokolldateien geschrieben werden. Zu den gültigen Werten (keine Informationen bis hin zu den detaillierten Informationen) gehören off, fatal, severe, warning, info, fine, finest und all. Beachten Sie, dass die Protokolle bei den Werten fine, finest und all möglicherweise sensible PHI-, PII- und PCI-DSS-Daten enthalten.
LOG_MAX_FILES 5 Die maximale Anzahl von Protokolldateien, Tracedateien und zusammenfassenden Protokolldateien zu Ausnahmebedingungen. Bei Erreichen dieses Grenzwerts wird die älteste Datei gelöscht und eine neue Datei erstellt. Wenn diese Variable beispielsweise auf 5 gesetzt wird, kann SMS Gateway bis zu 5 Nachrichtenprotokolle, 5 Traceprotokolle und 5 zusammenfassende Protokolldateien zu Ausnahmebedingungen generieren.
LOG_MAX_FILE_SIZE 100 Die maximale Größe in Megabyte (MB), die eine Protokolldatei haben kann, bevor eine neue Datei erstellt wird.
WLP_SKIP_UMASK false Der Server legt die Protokolldateiberechtigungen fest, um anderen Benutzern den Zugriff zu verweigern, wenn der Wert auf false gesetzt ist. Setzen Sie diese Eigenschaft auf true, um anderen Benutzer Lesezugriff zu gewähren.
MASK_CALLER_ID_FROM_MESSAGES false Wenn Sie Informationen zur Anrufer-ID in den SMS Gateway-Nachrichtenprotokollen maskieren möchten, setzen Sie den Wert für diese Variable in der Bereitstellungsscriptdatei (deploy script) auf true. Standardmäßig zeigt das SMS-Gateway die Informationen zur Anrufer-ID in den Nachrichtenprotokollen an. Im folgenden Beispiel werden die Informationen einer Anrufer-ID angezeigt, wenn diese Variable auf true gesetzt ist.
CWSMS0001I: Die angeforderte SMS-Sitzung zwischen dem Tenant und dem Benutzer wurde erstellt. tenantID = +18888888888 userID = ***

Proxy-Konfiguration für den SMS-Provider

Tabelle 4. Umgebungsvariablen für die Konfiguration des Proxy-Servers für den SMS-Provider
Umgebungsvariable Standardwert Beschreibung
SMS_PROXY_TYPE HTTP Der Typ des Forward-Proxy-Servers für Verbindungen zum SMS-Provider.
SMS_PROXY_HOST Nicht zutreffend Der Hostname eines Forward-Proxy-Servers für Verbindungen zum SMS-Provider.
SMS_PROXY_PORT Nicht zutreffend Der Port eines Forward-Proxy-Servers für Verbindungen zum SMS-Provider.
SMS_PROXY_USERNAME Nicht zutreffend Der Benutzername für den Forward-Proxy-Server für Verbindungen zum SMS-Provider. Geben Sie diese Variable nur an, wenn für den Proxy-Server eine Authentifizierung erforderlich ist.
SMS_PROXY_PASSWORD Nicht zutreffend Das Kennwort für den Forward-Proxy-Server für Verbindungen zum SMS-Provider. Geben Sie diese Variable nur an, wenn für den Proxy-Server eine Authentifizierung erforderlich ist.

Proxy-Konfiguration für den Watson Assistant-Service

Tabelle 5. Umgebungsvariablen für die Konfiguration des Proxy-Servers für den Watson Assistant-Service
Umgebungsvariable Standardwert Beschreibung
WCS_PROXY_TYPE HTTP Der Typ des Forward-Proxy-Servers für die Verbindungen zum Watson Assistant-Service.
WCS_PROXY_HOST Nicht zutreffend Der Hostname eines Forward-Proxy-Servers für die Verbindungen zum Watson Assistant-Service.
WCS_PROXY_PORT Nicht zutreffend Der Port des Forward-Proxy-Servers für die Verbindungen zum Watson Assistant-Service.
WCS_PROXY_USERNAME Nicht zutreffend Der Benutzername für den Forward-Proxy-Server für Verbindungen zum Watson Assistant-Service. Geben Sie diese Variable nur an, wenn für den Proxy-Server eine Authentifizierung erforderlich ist.
WCS_PROXY_PASSWORD Nicht zutreffend Das Kennwort für den Forward-Proxy-Server für Verbindungen zum Watson Assistant-Service. Geben Sie diese Variable nur an, wenn für den Proxy-Server eine Authentifizierung erforderlich ist.

Proxy-Konfiguration für Cloudant

Tabelle 6. Proxy-Konfiguration für Cloudant
Umgebungsvariable Standardwert Beschreibung
CLOUDANT_PROXY_USERNAME Ohne Gibt den Benutzernamen für den Forward-Proxy-Server für Verbindungen zum Cloudant-Service an. Geben Sie diese Variable nur an, wenn für den Proxy-Server eine Authentifizierung erforderlich ist.
CLOUDANT_PROXY_PASSWORD Ohne Gibt das Kennwort für den Forward-Proxy-Server für Verbindungen zum Cloudant-Service an. Geben Sie diese Variable nur an, wenn für den Proxy-Server eine Authentifizierung erforderlich ist.
CLOUDANT_PROXY_URL Ohne Gibt den Hostnamen und die Portnummer eines Forward-Proxy-Servers für Verbindungen zum Cloudant-Service an. Beispiel: http://cloudant-proxy.com:80

SSL- und TLS-Verschlüsselung konfigurieren

Tabelle 7. Umgebungsvariablen für die Konfiguration der SSL- und TLS-Verschlüsselung
Umgebungsvariable Standardwert Beschreibung
SSL_TRUST_STORE_FILE Bereitgestellt durch den Java™-SDK-Container. Die Datei, die die sicheren Schlüssel für die abgehenden SSL-Verbindungen enthält, einschließlich der Verbindungen zum Watson Assistant-Service, einer Serviceorchestrierungsengine, dem SMS-Provider oder XSLD-Caching-Server.
SSL_TRUST_PASSPHRASE Nicht zutreffend Die Kennphrase, die zur Sicherung der Truststore-Datei SSL_TRUST_STORE_FILE.
SSL_TRUST_FILE_TYPE JKS Das Format der für SSL_TRUST_STORE_FILE angegebenen Datei.
SSL_KEY_STORE_FILE Nicht zutreffend Die Keystore-Datei, die die vertrauenswürdigen Schlüssel für eingehende SSL-Verbindungen enthält.
SSL_KEY_PASSPHRASE Nicht zutreffend Die Kennphrase, die zur Sicherung der für SSL_KEY_STORE_FILE angegebenen Keystore-Datei verwendet wurde.
SSL_KEY_FILE_TYPE JKS Das Format der für SSL_KEY_STORE_FILE angegebenen Datei.

Umgebungsvariablen für die Konfiguration der Bereitschaftsprüfung

Tabelle 8. Umgebungsvariablen für die Konfiguration der Bereitschaftsprüfung
Umgebungsvariable Standardwert Beschreibung
SMS_ADMIN_USERNAME Ohne Gibt den Benutzernamen für den Administrator an, um die Anforderung der Bereitschaftsprüfung zu authentifizieren.
SMS_ADMIN_PASSWORD Ohne Gibt das Kennwort für den Administrator an, um die Anforderung der Bereitschaftsprüfung zu authentifizieren.

Umgebungsvariable für die Tenantkonfiguration

Für Single-Tenant-Umgebungen können Sie die folgenden Umgebungsvariablen in der Konfiguration definieren. In Multi-Tenant-JSON-Konfigurationen werden diese Umgebungsvariablen ignoriert, da die Eigenschaften in einer separaten JSON-Datei definiert sind.

Allgemeine Tenantkonfiguration

Tabelle 9. Allgemeine Tenantumgebungsvariablen
Umgebungsvariable Standardwert Beschreibung
TENANT_PHONE_NUMBER Nicht zutreffend Für Single-Tenant-Bereitstellungen wird die Telefonnummer vom SMS-Provider bereitgestellt. Verwenden Sie das exakte Zahlenformat, das der SMS-Provider benötigt. Alle Nachrichten werden an diese und von dieser Nummer gesendet.
ALLOW_SESSION_CREATE_VIA_SMS false Gibt an, ob Benutzer eine neue Messaging-Sitzung starten können, indem sie eine Nachricht an SMS Gateway senden. Setzen Sie den Wert auf true, um diese Funktion zu aktivieren.
CONVERSATION_FAILED_REPLY_MESSAGE Unable to respond to the SMS message due to an error Die Standardantwortnachricht, die an den Nachrichtenempfänger gesendet wird, wenn der Watson Assistant-Service nicht verfügbar ist.
SMS_PROVIDER_CONNECT_TIMEOUT 10000 Die Zeit in Millisekunden, die SMS Gateway auf das Herstellen einer Socketverbindung zum SMS-Provider wartet. Wenn der SMS-Provider nicht erreicht werden kann, schlägt der Anruf fehl.
SMS_PROVIDER_READ_TIMEOUT 10000 Die Zeit in Millisekunden, die SMS Gateway auf eine Antwort vom SMS-Provider wartet. Wenn der SMS-Provider nicht erreicht werden kann, schlägt der Anruf fehl.
SMS_PROVIDER_MAX_RETRY_NUM 2 Die maximale Anzahl von Wiederholungen, die SMS Gateway unternimmt, um eine Verbindung zu einem SMS-Service-Provider herzustellen, wenn ein Verbindungsfehler aufgetreten ist.
SMS_PROVIDER_RETRY_INTERVAL 0 Die Zeit in Sekunden, die SMS Gateway zwischen Wiederholungsversuchen warte, um eine Verbindung mit einem SMS-Service-Provider nach einem Verbindungsfehler wieder herzustellen.
TIMEOUT_FOR_SESSION `3600 Die Zeit in Sekunden, nach der die Sitzung abläuft, wenn SMS Gateway keine Antwort vom Benutzer empfängt.
WATSON_CONVERSATION_CONNECT_TIMEOUT 10000 Die Zeit in Millisekunden, die SMS Gateway auf das Herstellen einer Socketverbindung zum Watson Assistant-Service wartet. Wenn der Service nicht erreicht werden kann, schlägt die Transaktion fehl.
WATSON_CONVERSATION_READ_TIMEOUT 5000 Die Zeit in Millisekunden, die SMS Gateway auf eine Antwort vom Watson Assistant-Service wartet. Wenn der Service nicht erreicht werden kann, schlägt die Transaktion fehl.
WATSON_CONVERSATION_MAX_RETRY_NUM 2 Die maximale Anzahl von Wiederholungen, die SMS Gateway unternimmt, um eine Verbindung zu Watson Assistant herzustellen, wenn ein Verbindungsfehler aufgetreten ist.
WATSON_CONVERSATION_RETRY_INTERVAL 0 Die Zeit in Millisekunden, die SMS Gateway zwischen Wiederholungsversuchen warten, um eine Verbindung mit Watson Assistant nach einem Verbindungsfehler wiederherzustellen.
NOTIFY_ON_SESSION_TIMEOUT true Verwenden Sie diese Variable, wenn Watson Assistant oder die Serviceorchestrierungsengine den Ablauf von Sitzungen für den Tenant nicht verarbeitet. Setzen Sie diese Variable für den Tenant auf false. Standardmäßig ird SMS Gateway Watson Assistant bzw. die Serviceorchestrierungsengine darüber informieren, dass die Sitzung abgelaufen ist, indem smsResponseTimeout im Text gesendet wird.

Watson Assistant-Service konfigurieren<Œ

Tabelle 10. Umgebungsvariablen für die Konfiguration des Watson Assistant-Service
Umgebungsvariable Standardwert Beschreibung
WATSON_CONVERSATION_WORKSPACE_ID Nicht zutreffend Die ID Ihres Watson Assistant-Arbeitsbereichs. Diese ID ist von den Berechtigungsnachweisen des Service getrennt und wird im Watson Assistant-Tool unter den Arbeitsbereichsdetails aufgeführt.

Wenn Sie eine Verbindung zum Watson Assistant-Service über eine Serviceorchestrierungsengine herstellen, geben Sie diese Variable nicht an.
WATSON_CONVERSATION_USERNAME Nicht zutreffend Der Berechtigungsnachweis username für Ihren Watson Assistant-Service. Beachten Sie, dass es sich bei diesem Wert nicht um Ihren IBM Cloud-Benutzernamen handelt. Informationen zur Ermittlung Ihrer Serviceberechtigungsnachweise finden Sie unter Serviceberechtigungsnachweise für Watson-Services.

Verwenden Sie bei Serviceorchestrierungsengines diese Variable, um den Benutzernamen für die Serviceorchestrierungsengine anzugeben, wenn eine Authentifizierung erforderlich ist.
WATSON_CONVERSATION_PASSWORD Nicht zutreffend Der Berechtigungsnachweis password für Ihren Watson Assistant-Service. Beachten Sie, dass es sich bei diesem Wert nicht um Ihr IBM Cloud-Kennwort handelt. Informationen zur Ermittlung Ihrer Serviceberechtigungsnachweise finden Sie unter Serviceberechtigungsnachweise für Watson-Services.

Verwenden Sie bei Serviceorchestrierungsengines diese Variable, um das Kennwort für die Serviceorchestrierungsengine anzugeben, wenn eine Authentifizierung erforderlich ist.
WATSON_CONVERSATION_URL Nicht zutreffend Der Berechtigungsnachweis url für die Watson Assistant-Service-API, wie z. B. https://gateway.watsonplatform.net/conversation/api. Informationen zur Ermittlung Ihrer Serviceberechtigungsnachweise finden Sie unter Serviceberechtigungsnachweise für Watson-Services.

Verwenden Sie bei Serviceorchestrierungsengines diese Variable, um die genaue URL zur Serviceorchestrierungsengine anzugeben.
WATSON_CONVERSATION_API_VERSION 2017-05-26 Die Version der Watson Assistant-API, die verwendet werden soll. SMS Gateway unterstützt die Watson Assistant-API-Versionen 2017-05-26 und 2016-09-20.
WATSON_CONVERSATION_APIKEY Nicht zutreffend Der API-Schlüssel apikey, der Berechtigungsnachweis für Ihren Watson Assistant-Service. Sie können Verbindungen mit Watson-Services konfigurieren, indem Sie entweder WATSON_CONVERSATION_APIKEY verwenden und WATSON_CONVERSATION_TOKEN_SERVICE_PROVIDER_URL auf https://iam.cloud.ibm.com/identity/token festlegen, oder Sie konfigurieren WATSON_CONVERSATION_USERNAME mit apikey und WATSON_CONVERSATION_PASSWORD mit dem Wert für apikey. Gilt ab Version 1.0.1.0.
WATSON_CONVERSATION_TOKEN_AUTH_ENABLED false Aktiviert die Tokenauthentifizierung für den Watson Assistant-Service. Der Standardwert ist false, wodurch die Basisauthentifizierung aktiviert wird. Gilt ab Version 1.0.1.0.
WATSON_CONVERSATION_TOKEN_SERVICE_PROVIDER_URL https://gateway.watsonplatform.net/authorization/api/v1/token Die URL, über die das Authentifizierungstoken angefordert wird. Gilt ab Version 1.0.1.0.

SMS-Provider konfigurieren

Tabelle 11. Umgebungsvariablen für die Konfiguration des SMS-Providers
Umgebungsvariable Standardwert Beschreibung
SMS_PROVIDER_EXPLICIT_URL Nicht zutreffend Die exakte Endpunkt-URL der SMS-Provider-API zum Senden von Nachrichten. Geben Sie z. B. eine RestcommONE-URL als https://cloud.restcomm.com/restcomm/2012-04-24/Accounts/<YourAccountSID>/SMS/Messages.json und eine Twilio-URL als https://api.twilio.com/2010-04-01/Accounts/<YourAccountSID>/Messages.json an. Die URL wird exakt wie angegeben verwendet, um eine Verbindung zu Ihrem SMS-Provider herzustellen.

Diese Variable setzt die Variable SMS_PROVIDER_URL außer Kraft. Wenn Sie diese Variable angeben, wird jeder Wert, der für SMS_PROVIDER_URL angegeben wurde, ignoriert.
SMS_PROVIDER_URL Nicht zutreffend Die gekürzte Endpunkt-URL für die SMS-Provider-Messaging-API. Sie können beispielsweise über diese Variable die RestcommONE-URL als https://cloud.restcomm.com/restcomm/ oder eine Twilio-URL als https://api.twilio.com angeben.

Wenn Sie diese Variable angeben, geben Sie nicht zusätzlich den Wert für SMS_PROVIDER_EXPLICIT_URL an.
SMS_PROVIDER_USERNAME Nicht zutreffend Der Benutzerberechtigungsnachweis für den SMS-Provider, der in der Regel der Konto-SID zugeordnet ist.
SMS_PROVIDER_PASSWORD Nicht zutreffend Der Kennwortberechtigungsnachweis für den SMS-Provider, der in der Regel dem Auth-Token zugeordnet ist.

HTTP-Basisauthentifizierung für die REST-API und den SMS-Provider-Webhook konfigurieren

Tabelle 12. Umgebungsvariablen für die Konfiguration der HTTP-Basisauthentifizierung
Umgebungsvariable Standardwert Beschreibung
CTRL_TENANT_USERNAME Nicht zutreffend Ein Benutzername, der die Basisauthentifizierung aktiviert, um die REST-API zu verwenden. Wenn diese Variable definiert ist, müssen sich Benutzer authentifizieren, wenn sie REST-API-Anforderungen senden.
CTRL_TENANT_PASSWORD Nicht zutreffend Ein Kennwort für die Basisauthentifizierung für das Senden von REST-API-Nachrichtenanforderungen.
SMS_WEBHOOK_USERNAME Nicht zutreffend Ein Benutzername, der die Basisauthentifizierung aktiviert, um Nachrichtenanforderungen vom SMS-Provider senden zu können. Dieser Wert muss als Teil der Webhook-URL in der SMS-Provider-Konfiguration angegeben werden.
SMS_WEBHOOK_PASSWORD Nicht zutreffend Ein Kennwort für die Basisauthentifizierung, um Nachrichtenanforderungen vom SMS-Provider zu senden. Dieser Wert muss als Teil der Webhook-URL in der SMS-Provider-Konfiguration angegeben werden.

Umgebungsvariablen für Berichterstellungsereignisse in SMS Gateway

Tabelle 13. Umgebungsvariablen für SMS-Berichterstellung
Umgebungsvariable Standardwert Beschreibung
SMSGW_HOST "9.42.89.143" Für die Aktivierung der Berichterstellung erforderlich. Entweder der Hostname oder die im Bericht enthaltene IP-Adresse. In einer IBM Cloud Private-Multi-Tenant-Konfigurationsumgebung ist dieser Wert auf podIP gesetzt.
ENABLE_LIMIT_ON_REPORTING_BACKUP_FILES_PER_TENANT false Aktiviert oder inaktiviert einen Grenzwert für die Anzahl der Dateien, die für die Berichterstellungsereignisse gesichert werden können.
REPORTING_USAGE_MAX_BACKUP_FILES_PER_TENANT 100 Wenn die Eigenschaft für die Festlegung des Grenzwerts auf true gesetzt ist, wird der Standardwert auf 100 Dateien für Nutzungsberichte pro Tenant festgelegt.
REPORTING_TRANSCRIPTION_MAX_BACKUP_FILES_PER_TENANT 1000 Wenn die Eigenschaft für die Festlegung des Grenzwerts auf true gesetzt ist, wird der Standardwert auf 1.000 Transkriptionsberichte pro Tenant festgelegt.
MAX_EVENTS_TO_BATCH 500 Die maximale Anzahl an Berichterstellungsereignissen, die pro Tenant bei einmaliger Veröffentlichung zusammengestellt werden können.

Umgebungsvariablen für die Veröffentlichung von Berichterstellungsereignissen in einem REST-Server

Tabelle 14. Umgebungsvariablen für Verbindungs- und Ereignisindizes
Umgebungsvariable Beispielwert Beschreibung
REPORTING_URL https://myresteventserver.ibm.com Der Hostname des Splunk-HEC-Servers oder HTTP-Servers, der die Ereignisse empfängt.
REPORTING_USERNAME 14feeb-d29c-48a0-1276bab3 Der für die Basisauthentifizierung verwendete Berechtigungsname. Beim Splunk-HEC kann dieser Wert eine beliebige Zeichenfolge sein.
REPORTING_PASSWORD e11bea167aed827399d55725c45 Das für die Basisauthentifizierung verwendete Berechtigungskennwort. Setzen Sie diesen Wert beim Splunk-HEC auf das von Splunk generierte Token.
REPORTING_TRANSCRIPTION_EVENT_INDEX transcription Eine Zeichenfolge, die das Ereignis als Berichterstellungsereignis für Transkriptionen (z. B. "transcription") angibt. Der angegebene Wert ist im Indexfeld aller Berichterstellungsereignisse für Transkriptionen enthalten. Diese Variable muss zum Generieren von Berichterstellungsereignissen für Transkriptionen definiert sein.
REPORTING_USAGE_EVENT_INDEX usage Eine Zeichenfolge, die das Ereignis als Nutzungsereignis (z. B. "usage") angibt. Der angegebene Wert ist im Indexfeld aller Nutzungsberichterstellungsereignisse enthalten. Diese Variable muss zum Generieren von Nutzungsberichterstellungsereignissen definiert sein.

Umgebungsvariablen für die Veröffentlichung von Berichterstellungsereignissen in IBM Cloudant

Umgebungsvariablen für Berichterstellungsereignisse für Transkriptionen für IBM Cloudant

Tabelle 15. Variablen für die Veröffentlichung von Berichterstellungsereignissen für Transkriptionen in IBM Cloudant
Umgebungsvariable Beispielwert Beschreibung
REPORTING_TRANSCRIPTION_CLOUDANT_URL https://transcriptionCloudantURL.com Eine Zeichenfolge, die die anderen Berechtigungsnachweisinformationen in einer einzigen URL zusammenführt. Der Wert ist dann über die Berechtigungsnachweise des IBM Cloudant-Instanzservice verfügbar.
REPORTING_TRANSCRIPTION_CLOUDANT_DB_NAME sms-trans-db Der Name der IBM Cloudant-Datenbank für Ihre Berichterstellungsereignisse für Transkriptionen.
REPORTING_TRANSCRIPTION_CLOUDANT_ACCOUNT ABC Bei Berichterstellungsereignissen für Transkriptionen eine Zeichenfolge, die den IBM Cloudant-Kontonamen definiert, wenn der Benutzername und der Kontoname unterschiedlich sind. In der Regel sind der Benutzername und der Kontoname für IBM Cloudant identisch.
REPORTING_TRANSCRIPTION_CLOUDANT_USERNAME eb14feeb-d29c-48a0-1276bab37f75 Bei Berichterstellungsereignissen für Transkriptionen der Benutzername, der Ihren IBM Cloudant-Serviceberechtigungsnachweisen zugeordnet ist.
REPORTING_TRANSCRIPTION_CLOUDANT_PASSWORD eb14feeb-d29c-48a0-1276bab37f75 Bei Berichterstellungsereignissen für Transkriptionen das Kennwort, das Ihren IBM Cloudant-Serviceberechtigungsnachweisen zugeordnet ist.
REPORTING_TRANSCRIPTION_CLOUDANT_API_KEY ObrVygb8Gf0M1Qji4vgqr-nNgHjv Bei Berichterstellungsereignissen für Transkriptionen der API-Schlüssel, der Ihren IBM Cloudant-Serviceberechtigungsnachweisen zugeordnet ist.
REPORTING_TRANSCRIPTION_CLOUDANT_EVENT_INDEX transcription Eine Zeichenfolge, die das Ereignis als Berichterstellungsereignis für Transkriptionen (z. B. "transcription") angibt. Der angegebene Wert ist im Indexfeld aller Berichterstellungsereignisse für Transkriptionen enthalten, die an Ihre IBM Cloudant-Datenbank berichtet werden. Diese Variable muss zum Generieren von Berichterstellungsereignissen für Transkriptionen definiert sein, die in Ihrer Datenbank veröffentlicht werden sollen.

Umgebungsvariablen für Nutzungsberichterstellungsereignisse für IBM Cloudant

Tabelle 16. Variablen für die Veröffentlichung von Nutzungsberichterstellungsereignissen in IBM Cloudant
Umgebungsvariable Beispielwert Beschreibung
REPORTING_USAGE_CLOUDANT_URL https://usageCloudantURL.com Die URL, die Ihre IBM Cloudant-Instanz zum Speichern von Nutzungsberichterstellungsereignissen hostet.
REPORTING_USAGE_CLOUDANT_DB_NAME sms-usage-db Bei Nutzungsberichterstellungsereignissen der Benutzername, der Ihren IBM Cloudant-Serviceberechtigungsnachweisen zugeordnet ist.
REPORTING_USAGE_CLOUDANT_ACCOUNT ABC Bei Nutzungsberichterstellungsereignissen der Kontoname, der in der Regel mit dem Ihrer IBM Cloud-Instanz übereinstimmt.
REPORTING_USAGE_CLOUDANT_USERNAME eb14feeb-d29c-48a0-1276bab37f75 Bei Nutzungsberichterstellungsereignissen der Benutzername, der Ihren IBM Cloudant-Serviceberechtigungsnachweisen zugeordnet ist.
REPORTING_USAGE_CLOUDANT_PASSWORD eb14feeb-d29c-48a0-1276bab37f75 Bei Nutzungsberichterstellungsereignissen das Kennwort, das Ihren IBM Cloudant-Serviceberechtigungsnachweisen zugeordnet ist.
REPORTING_USAGE_CLOUDANT_API_KEY ObrVygb8Gf0M1Qji4vgqr-nNgHjv Bei Nutzungsberichterstellungsereignissen der API-Schlüssel, der Ihren IBM Cloudant-Serviceberechtigungsnachweisen zugeordnet ist.
REPORTING_USAGE_CLOUDANT_EVENT_INDEX usage Eine Zeichenfolge, die das Ereignis als Nutzungsereignis (z. B. "usage") angibt. Der angegebene Wert ist im Indexfeld aller Nutzungsberichterstellungsereignisse enthalten, die an Ihre IBM Cloudant-Datenbank berichtet werden. Diese Variable muss zum Generieren von Nutzungsberichterstellungsereignissen definiert sein, die in Ihrer Datenbank veröffentlicht werden sollen.