telekom-adapter v1.0.0

Flixcheck Telekom Adapter

The purpose of this application is to receive answered checks from Flixcheck and send them via mail to the account's email address.

Environment variables

• ERROR_RECIPIENT
  E-mail address of the recipient of error emails.
• FLIXCHECK_USER_ID
  User ID of the administrator of the highest Flixcheck Telekom account.
• FLIXCHECK_API_KEY
  API key of the user defined by FLIXCHECK_USER_ID.
• FLIXCHECK_BASE_URL
  Base URL of the Flixcheck service. No trailing slash!
• FLIXCHECK_ROOT_USER_ID
  Root User ID of a root user that has the privilige updateUser in the Telekom corporation
• FLIXCHECK_ROOT_USER_API_KEY
  API key of the user defined by FLIXCHECK_ROOT_USER_ID.
• PORT
  Port of the HTTP server.
• BASE_URL
  Public base url of the server (protocoll, host, port; no trailing slash)
• GRAYLOG_HOST and GRAYLOG_PORT optional
  If set, logs will be sent to graylog
• CM_ACCOUNT_ID and CM_PRODUCT_TOKEN
  CM credentials
• FROM_ADDRESS and FROM_NAME
  From settings for mails; address must be added at CM!
• ZEUS_BEARER_TOKEN
  Token for ZEUS to call its routes
• SAML_PRIVATE_KEY
  Own server SAML private key
• SAML_PUBLIC_KEY
  Own server SAML public key
• SAML_IDP_LOGIN_URL
  IdP login url
• SAML_IDP_LOGOUT_URL
  IdP logout url
• SAML_IDP_PUBLIC_KEY
  IdP public key
• SAML_SIGN_GET optional
  Set to 1 if request should be signed
• SAML_ALLOW_UNENCR optional
  Set to 1 if unencrypted answers are allowed
• SAML_REQUIRE_SESSION_INDEX optional
  Set to 1 if session indexes are required
• MONGODB_CONNECTION_STRING
  MongoDB connection string for ZEUS and other app-related data
• AGENDA_MONGODB_CONNECTION_STRING
  MongoDB connection string for planned tasks by agenda
• DELETE_OLD_USERS_AFTER_DAYS
  After how many days the old user of a team-switch should be removed
• DMS_ACTIVE_CUSTOM_VALUE
  Only archive check to dms if it has a custom values with identifier dmsActive and a value that equals this env var's value. If it is not set the checked value is ja.
• DMS_PUBLIC_KEY_PATH
  Path to dms public key, relative to project root, starting with /
• IRRP_DOK_KAT_WITH_MAIL_SUBJECT
  List of numbers (document categories) which will lead to an irrp mail with subject (thus with automatic processing); multiple values are separated by , without any spaces!
• IRRP_RECIPIENT
  Mail address for irrp mails

Account Custom Values

• adapterRecipient
  Value mustbe an email address; check answers will be sent via email to that address
• bereich required
• adapterRequiredCustomerNumberLengths
  • Note: plural
  • Value must be a number (thus, parseInt should not return NaN)
  • Possible to provide multiple numbers, seperated by ,
  • If set, the account needs to provide the check custom value kundennummer with one of the provided lengths
• adapterRequiredBuchungskontoLength
  If set and a check has a custom value buchungskonto, then the value has to have the provided length.
• adapterRequiredInvoiceNrLength
  If set and a check as a custom value invoiceNr1 / invoiceNr2 / ... / invoiceNr10, then the value has to have the provided length.
• adapterRequiredRvNrLengths
  If set and a check as a custom value rvnr, then the value has to have one of the provided lengths (divided by ,).
• adapterSandbox
  If set to 1, then no adapter action will be applied for answered checks.

Check Custom Values

• betroffenerufnummer
  If provided, that phone number has to start with 015, 016 or 017.
• irrpActive will sent the answered check to irrp if ...
  • it is set to "ja" and adapterDivision is set to "MF"
  • it is set to "immer"
• dmsActive will upload the answered check to DMS if ...
  • it is set to "ja" and adapterDivision is set to "FN"
  • it is set to "immer"
• adapterRequiredBuchungskontoLength
  see above
• adapterRequiredInvoiceNrLength
  see above
• adapterRequiredRvNrLength
  see above
• mspActive will sent the answer to msp if it is set to "ja"
  • Use an element custom value with identifier mspDivisionSwitch to set which element will determine whether the MSP export will use Festnetz or Mobilefunk mode
    • in the value of mspDivisionSwitch, use this format to set the choiceIds for Festnetz and Mobilfunk: FN=choiceIdForFn,MF=choiceIdForMf
  • Use element custom values with identifier mspIndexField to identify the elements for index fields. Use the following values for the indexfields:
    • kundennummer
    • vorwahl
    • rufnummer
    • mobilfunknummer
    • iccid

Element Custom Values

• If two or more text question elements should contain the same values, you need to ...
  • Add an element custom value with the same identifier
  • That identifier needs to start with same_value_, e.g. same_value_mobile_nr
  • The label of the custom value isn't relevant, just call it "Werteabgleich"
  • As value of the custom values, use a word the describes what should be equal. It will be used in the error message:

    Die eingegebenen Werte für {{ value }} sind nicht identisch.