ScopedDCManager - com escopo

  • Versão de lançamento: Xanadu
  • Atualizado 1 de ago. de 2024
  • 4 min. de leitura
  • A API ScopedDCManager permite agrupar dados por tipo.

    Usando esta API, você pode:
    • Atribua classificações de dados a entradas de dicionário existentes.
    • Pesquise as classificações de dados para entradas de dicionário específicas.
    • Remova todas as classificações de dados associadas a entradas de dicionário específicas.
    • Recupere uma lista de todas as classificações de dados disponíveis no domínio atual.

    Esta API requer o plug-in Classificação de dados [com.glide.data_classification].

    Para obter mais informações, consulte Classificação de dados.

    ScopedDCManager - classificar(cadeia de caracteres dictEntries, cadeia de caracteres dataClasses)

    Atribui classificações de dados predefinidas ou definidas pelo usuário a entradas de dicionário existentes.

    Requer a função admin ou data_classification_admin.

    Tabela 1. Parâmetros
    Nome Tipo Descrição
    dictEntries Cadeia de caracteres Os sys_ids dos registros que você deseja classificar. Os sys_ids são da tabela Dicionário [sys_dictionary]. Inserido como uma lista separada por vírgulas entre uma cadeia de caracteres.
    dataClasses Cadeia de caracteres Os sys_ids das classificações de dados que você deseja atribuir. Os sys_ids são da tabela Classificação de dados [data_classification]. Inserido como uma lista separada por vírgulas entre uma cadeia de caracteres.
    Tabela 2. Retorna
    Tipo Descrição
    Cadeia de caracteres Mensagem que descreve o resultado da operação.

    Este exemplo encontra registros que contêm números de previdência social e os classifica como confidenciais.

    var dcm = new global.ScopedDCManager();
    var confidentialClass = {};
    var ssnFields = [];
    var dataClasses = JSON.parse(dcm.getAllDataClasses());
    
    // Get the Confidential data class record
    dataClasses.forEach(function (dataClass) {
      if (dataClass.name == "Confidential")
        confidentialClass = dataClass;
    });
    
    // Find the fields that seem to be strong social security numbers
    var dictionaryGR = new GlideRecord("sys_dictionary");
    dictionaryGR.addQuery("element", "ssn").addOrCondition("element", "social_security_number");
    dictionaryGR.query();
    while (dictionaryGR.next())
      ssnFields.push(dictionaryGR.getUniqueValue());
    
    // Classify any found entries as confidential
    if (ssnFields.length > 0)
      dcm.classify(ssnFields.join(), confidentialClass.sys_id);
    
    Saída:
    "Successfully stored the data classification configurations"

    ScopedDCManager - clearClassification(String dictEntries)

    Remove todas as classificações de dados das entradas de dicionário especificadas.

    Requer a função admin ou data_classification_admin.

    Tabela 3. Parâmetros
    Nome Tipo Descrição
    dictEntries Cadeia de caracteres Os sys_ids dos registros dos quais você deseja remover classificações. Os sys_ids são da tabela Dicionário [sys_dictionary]. Inserido como uma lista separada por vírgulas entre uma cadeia de caracteres.
    Tabela 4. Retorna
    Tipo Descrição
    Cadeia de caracteres Mensagem que descreve o resultado da operação.

    Este exemplo remove a classificação de dados de uma entrada de dicionário.

    var dcm = new global.ScopedDCManager();
    gs.info(dcm.clearClassification("445de0a6dba30300efc57416bf9619b0"));
    

    Saída:

    "Classifications removed for the specified dictionary entries"

    ScopedDCManager – getAllDataClasses()

    Retorna uma lista de todas as classificações de dados disponíveis no domínio atual.

    Requer a função admin, data_classification_admin ou data_classification_auditor.

    Tabela 5. Parâmetros
    Nome Tipo Descrição
    Nenhum
    Tabela 6. Retorna
    Tipo Descrição
    <Array>

    Resultado da solicitação. Retorna o sys_id e o nome de cada classificação de dados disponível. Se não houver classificações de dados, ele retornará uma matriz vazia.

    As classificações de dados podem ser organizadas em relacionamentos primário-secundário. Se houver classificações de dados primários, elas serão identificadas no resultado.

    Tipo de dados: matriz

    [
      {
        "parent": {Object},
        "sys_id": "String",
        "name": "String"
      }
    ]
    <Array>.primário Entrada para uma classificação de dados primária.

    Tipo de dados: objeto

    "parent": {
      "sys_id": "String",
      "name": "String"
    }
    <Array>.parent.sys_id Sys_id da classificação de dados primária da tabela Classificação de dados [data_classification].

    Tipo de dados: cadeia de caracteres

    <Array>.parent.name Nome da classificação de dados primária.

    Tipo de dados: cadeia de caracteres

    <Array>.sys_id Sys_id da classificação de dados da tabela Classificação de dados [data_classification].

    Tipo de dados: cadeia de caracteres

    <Array>.nome Nome da classificação de dados.

    Tipo de dados: cadeia de caracteres

    Este exemplo recupera uma lista de todas as classificações de dados disponíveis.

    var dcm = new global.ScopedDCManager();
    gs.info(dcm.getAllDataClasses());
    

    Saída:

    [
      {
        "parent": {
          "sys_id": "a9670fc773fc1010ae8dd21efaf6a735",
          "name": "Confidential"
        },
        "sys_id": "348107b951d71010f877f3f178e7dd0d",
        "name": "Personally identifiable information"
      },
      {
        "sys_id": "a9670fc773fc1010ae8dd21efaf6a735",
        "name": "Confidential"
      },
      {
        "sys_id": "59b7070b73fc1010ae8dd21efaf6a764",
        "name": "Restricted"
      },
      {
        "sys_id": "11d60fc773fc1010ae8dd21efaf6a744",
        "name": "Internal"
      },
      {
        "sys_id": "f5b4cf4773fc1010ae8dd21efaf6a766",
        "name": "Public"
      }
    ]

    ScopedDCManager – getClassification(String dictEntries)

    Recupera todas as classificações de dados das entradas de dicionário especificadas.

    Requer a função admin, data_classification_admin ou data_classification_auditor.

    Tabela 7. Parâmetros
    Nome Tipo Descrição
    dictEntries Cadeia de caracteres Os sys_ids dos registros para os quais você deseja recuperar classificações. Os sys_ids são da tabela Dicionário [sys_dictionary]. Inserido como uma lista separada por vírgulas entre uma cadeia de caracteres.
    Tabela 8. Retorna
    Tipo Descrição
    <Object>

    Objeto JSON que contém o sys_id de cada entrada do dicionário com uma matriz de suas classes de dados associadas. Se não houver classificações de dados associadas, ele retornará uma mensagem descrevendo o resultado da operação.

    As classificações de dados podem ser organizadas em relacionamentos primário-secundário. Se houver classificações de dados primários, elas serão identificadas no resultado.

    Tipo de dados: objeto

    {
      <sys_dictionary_sys_id>: [
        {
          "parent": {Object},
          "sys_id": "String",
          "name": "String"
        }
      ]
    }
    
    <Object>.primário Entrada para uma classificação de dados primária.

    Tipo de dados: objeto

    "parent": {
      "sys_id": "String",
      "name": "String"
    }
    <Object>.parent.sys_id Sys_id da classificação de dados primária da tabela Classificação de dados [data_classification].

    Tipo de dados: cadeia de caracteres

    <Object>.parent.name Nome da classificação de dados primária.

    Tipo de dados: cadeia de caracteres

    <Object>.sys_id Sys_id da classificação de dados da tabela Classificação de dados [data_classification].

    Tipo de dados: cadeia de caracteres

    <Object>.nome Nome da classificação de dados.

    Tipo de dados: cadeia de caracteres

    Este exemplo recupera as classificações de dados para uma entrada de dicionário.

    var dcm = new global.ScopedDCManager();
    gs.info(dcm.getClassification("445de0a6dba30300efc57416bf9619b0"));
    

    Saída:

    {
      "445de0a6dba30300efc57416bf9619b0": [
        {
          "parent": {
            "sys_id": "a9670fc773fc1010ae8dd21efaf6a735",
            "name": "Confidential"
          },
          "sys_id": "348107b951d71010f877f3f178e7dd0d",
          "name": "Personally identifiable information"
        }
      ]
    }