PSBPublicAPIUtil - com escopo, global

  • Versão de lançamento: Xanadu
  • Atualizado 1 de ago. de 2024
  • 4 min. de leitura
  • A inclusão de script PSBPublicAPIUtil fornece métodos que permitem executar operações em Central de controle de serviços registros de configuração.

    Existem dois tipos de registros de configuração Central de controle de serviços nos quais você pode executar operações usando esta inclusão de script:
    • Produtores de registros remotos (RRP)
    • Definição de tarefa remota (RTD)
    Você pode executar qualquer uma das seguintes Central de controle de serviços operações nesses registros de configuração:
    • Check-out: cria uma versão de rascunho de um registro de configuração especificado. Qualquer versão publicada ainda está disponível para uso do cliente.
    • Publicar: publica a versão de rascunho de um registro de configuração especificado e o disponibiliza para uso do cliente.
    • Arquivar: arquiva uma versão inativa de um registro de configuração especificado e o torna indisponível para os clientes.
    • Descontinuar: descontinua todas as versões de um registro de configuração especificado e as torna indisponíveis para os clientes.

    Para obter informações adicionais sobre Central de controle de serviços registros de configuração, consulte Create configuration revisions.

    Para acessar esta API, a aplicação Central de controle de serviços para provedores (sn_sb_pro) e a base Central de controle de serviços (sn_sb) devem ser instaladas em sua instância.

    Você chama os métodos nesta API usando a inclusão de script sb. O código para esses métodos, no entanto, reside na inclusão de script PSBPublicAPIUtil.

    Ao chamar esses métodos do escopo global, use a seguinte sintaxe:
    sb.checkout(glideRecord);
    sb.publish(glideRecord);
    sb.archive(glideRecord);
    sb.retire(glideRecord);
    Ao chamá-los de uma aplicação com escopo, use esta sintaxe:
    global.sb.checkout(glideRecord);
    global.sb.publish(glideRecord);
    global.sb.archive(glideRecord);
    global.sb.retire(glideRecord);

    PSBPublicAPIUtil - archive(glideRecord)

    Valida se o GlideRecord especificado é um registro de configuração Central de controle de serviços válido e verifica se o registro está no estado "inativo". Se esta validação for aprovada, arquivará o registro de configuração especificado, deixando todas as outras versões do mesmo registro de configuração inalteradas.

    Para obter informações adicionais sobre revisões de configuração e seus estados associados, consulte Create configuration revisions.

    Tabela 1. Parâmetros
    Nome Tipo Descrição
    glideRecord GlideRecord Registro de configuração a ser arquivado.
    Este registro pode ser um dos seguintes:
    • Produtores de registros remotos (RRP): registros localizados na tabela Produtores de registros remotos [sn_sb_pro_remote_record_producer].
    • Definição de tarefa remota (RTD): registros localizados na tabela Definição de tarefa remota [sn_sb_pro_remote_task_def].
    Tabela 2. Retorna
    Tipo Descrição
    Booliano Sinalizador que indica se o registro de configuração foi arquivado.
    Valores possíveis:
    • verdadeiro: o registro de configuração foi arquivado.
    • falso: ocorreu um erro; O registro de configuração não foi arquivado.

    O exemplo de código a seguir mostra como chamar este método do escopo global em um registro de configuração de FDS.

    var grConfig = new GlideRecord('sn_sb_pro_remote_record_producer'); // Configuration table that contains the desired record 
    grConfig.get('0ed11101ff6aca10c1befe258c4fd99e'); // Sys_id of the configuration record to publish
    var isExecuted = sb.archive(grConfig);

    PSBPublicAPIUtil - check-out(glideRecord)

    Valida se o GlideRecord especificado é um registro de configuração Central de controle de serviços válido e verifica se o registro está no estado "publicado". Se esta validação for aprovada, criará uma nova versão do registro de configuração especificado e definirá o campo de estado como "rascunho".

    Tabela 3. Parâmetros
    Nome Tipo Descrição
    glideRecord GlideRecord Registro de configuração para check-out.
    Este registro pode ser um dos seguintes:
    • Produtores de registros remotos (RRP): registros localizados na tabela Produtores de registros remotos [sn_sb_pro_remote_record_producer].
    • Definição de tarefa remota (RTD): registros localizados na tabela Definição de tarefa remota [sn_sb_pro_remote_task_def].
    Tabela 4. Retorna
    Tipo Descrição
    GlideRecord Se for bem-sucedido, retornará o registro de configuração recém-criado com o campo de estado definido como "rascunho".

    Se ocorreu um erro, retorna nulo.

    O exemplo de código a seguir mostra como chamar este método do escopo global em um registro de configuração de RTD.

    var grConfig = new GlideRecord('sn_sb_pro_remote_task_def'); // Configuration table that contains the desired record 
    grConfig.get('0ed11101ff6aca10c1befe258c4fd99e'); // Sys_id of the configuration record to checkout
    var checkoutGr = sb.checkout(grConfig);

    PSBPublicAPIUtil - publicar (glideRecord)

    Valida se o GlideRecord especificado é um registro de configuração Central de controle de serviços válido e verifica se o registro está no estado "rascunho". Se esta validação for aprovada, publica a versão de rascunho do registro de configuração.

    Tabela 5. Parâmetros
    Nome Tipo Descrição
    glideRecord GlideRecord Registro de configuração a ser publicado.
    Este registro pode ser um dos seguintes:
    • Produtores de registros remotos (RRP): registros localizados na tabela Produtores de registros remotos [sn_sb_pro_remote_record_producer].
    • Definição de tarefa remota (RTD): registros localizados na tabela Definição de tarefa remota [sn_sb_pro_remote_task_def].
    Tabela 6. Retorna
    Tipo Descrição
    Booliano Sinalizador que indica se o registro de configuração foi publicado.
    Valores possíveis:
    • verdadeiro: o registro de configuração foi publicado.
    • falso: ocorreu um erro; O registro de configuração não foi publicado.

    O exemplo de código a seguir mostra como chamar este método do escopo global em um registro de configuração de RRP.

    var grConfig = new GlideRecord('sn_sb_pro_remote_record_producer’'); // Configuration table that contains the desired record 
    grConfig.get('0ed11101ff6aca10c1befe258c4fd99e'); // Sys_id of the configuration record to publish
    var isExecuted = sb.publish(grConfig);

    PSBPublicAPIUtil - retirar (glideRecord)

    Valida se o GlideRecord especificado é um registro de configuração Central de controle de serviços válido e verifica se o registro está em um estado válido. Se esta validação for aprovada, descontinuará a versão especificada do registro de configuração junto com todas as outras revisões desse mesmo registro de configuração.

    Para obter informações adicionais sobre revisões de configuração e seus estados associados, consulte Create configuration revisions.

    Tabela 7. Parâmetros
    Nome Tipo Descrição
    glideRecord GlideRecord Registro de configuração a ser descontinuado.
    Este registro pode ser um dos seguintes:
    • Produtores de registros remotos (RRP): registros localizados na tabela Produtores de registros remotos [sn_sb_pro_remote_record_producer].
    • Definição de tarefa remota (RTD): registros localizados na tabela Definição de tarefa remota [sn_sb_pro_remote_task_def].
    Tabela 8. Retorna
    Tipo Descrição
    Booliano Sinalizador que indica se o registro de configuração foi descontinuado.
    Valores possíveis:
    • verdadeiro: o registro de configuração foi descontinuado.
    • falso: ocorreu um erro; O registro de configuração não foi descontinuado.

    O exemplo de código a seguir mostra como chamar este método do escopo global em um registro de configuração de RTD.

    var grConfig = new GlideRecord('sn_sb_pro_remote_task_def'); // Configuration table that contains the desired record 
    grConfig.get('0ed11101ff6aca10c1befe258c4fd99e'); // Sys_id of the configuration record to checkout
    var isExecuted = sb.retire(grConfig);