Skip to content

Documentație

Communications

Obiectul JS Communications poate fi utilizat în scripturi personalizabile de către utilizator în cadrul CYBERQUEST Data Transformation Service (DTS) și în alerte. Acest obiect poate fi…

Obiectul JS Communications poate fi utilizat în scripturi personalizabile de către utilizator în cadrul CYBERQUEST Data Transformation Service (DTS) și în Alerts. Acest obiect poate fi apelat folosind subobiecte, precum:

HttpRequest

Această clasă este un wrapper care încapsulează clientul http pe ținte specifice (windowsagent etc.).

Toate metodele care trimit cereri vor returna un răspuns formatat uniform, împreună cu codul de stare sau cu eventualele erori.

Clasa este accesată prin obiectul global CQ, folosind CQ.Communications.HttpRequest.

Utilizare:

  config = {
  method: 'post',
  data: null,
  withCredentials: false, // default
  CredentialsType: 'plain', // default [encrypted,plain,managed]
  timeout: 60000, // default is `60` seconds in milliseconds
  rejectUnauthorized: false, //default to check for ssl certificate
  
  auth: { //or the GUID for managed credentials auth:23F08431-2C0E-CC1B-5CBE-0677E5FFAD7B
  username: 'user',
  password: 'pass'//for plain text, or the encrypted password for encrypted method
  },
  headers: {},
  cookies: []
  };

HttpRequest.get

CQ.Communications.HttpRequest.get(url, config=null)
  • HttpResponse

HttpRequest.post

CQ.Communications.HttpRequest.post(url, data, config=null)
  • HttpResponse

HttpRequest.put

CQ.Communications.HttpRequest.put(url, data, config=null)
  • HttpResponse

HttpRequest.delete

CQ.Communications.HttpRequest.delete(url, config=null)
  • HttpResponse

HttpRequest.head

CQ.Communications.HttpRequest.head(url, config=null)
  • HttpResponse

HttpResponse

Proprietăți:

  • int statusCode
  • string data - Corpul brut al răspunsului
  • Array headers - Antetele răspunsului

HttpResponse.asJson()

Parsează corpul răspunsului ca JSON.

HttpResponse.asXml()

Parsează corpul răspunsului ca XML.

Notification.sendMessage

Parametri:

  • text - acesta este mesajul notificării
  • type - către ce platformă este trimisă notificarea (email în mod implicit, poate fi trimisă și către slack sau teams)
  • additionalParamateres (url obligatoriu, subjectData opțional, to opțional)

Ținând cont de parametrul type al metodei sendMessage, modulul va selecta clasa particulară corespunzătoare, o va instanția conform regulilor proprii și va expedia notificarea.

Utilizare:

CQ.Communications.sendMessage(message,platform(slak/teams/email),objectConfiguration{url:"",to:"optional",subjectData:"optional"})