ServiceNow Application Scope

UiPath.ServiceNow.Activities.ServiceNowScopeActivity

Dica:

While the ServiceNow Application Scope activity can use standard authentication (UserName) and (Password), it is highly recommend to use OAuth security for all your connections per the steps below.

As atividades do ServiceNow usam o protocolo OAuth 1.0 para estabelecer uma conexão autenticada entre o UiPath e sua instância do ServiceNow. Essa conexão autoriza um robô a chamar as APIs do ServiceNow e acessar recursos em seu nome.

Para habilitar a autorização, você cria um ponto de extremidade de aplicativo OAuth para sua instância do ServiceNow. A criação desse ponto de extremidade gera um registro do aplicativo cliente do OAuth, ID do cliente e Segredo do cliente para habilitar o acesso autenticado à sua instância.

After creating your endpoint, you enter your ServiceNow credentials along with the application endpoint URL, Client ID, and Client Secret in the ServiceNow Application Scope activity.

Dica:

As funções de usuário de integração devem receber apenas as permissões mínimas necessárias para executar as tarefas habilitadas pelas atividades nesse pacote (por exemplo, admin, itil, tenant_ecc e etc. não devem ser usadas para funções de usuário de integração). Os Serviços da Web de entrada que modificam tabelas devem ser restritos às funções do sistema apropriadas. Para obter mais informações, consulte a seção Funções na documentação do ServiceNow.

Como funciona

As etapas a seguir e o diagrama de sequência de mensagens são um exemplo de como a atividade funciona desde o tempo de design (ou seja, as dependências da atividade e as propriedades de entrada/saída) até o tempo de execução.

1. Conclua as etapas de Configuração .
2. Adicione uma atividade para cada propriedade de entrada SecureString (por exemplo, dois no total: uma para Senha e uma para SegredoDoCliente)
3. Add the ServiceNow Application Scope activity to your project.
4. Insira valores para as propriedades Autenticação e Conexão .
5. Crie e insira uma variável IConnection para propriedades de Saída .

   • You can use this variable in subsequent uses of the ServiceNow Application Scope activity.

     

Se você encontrar problemas ao usar a autenticação padrão, consulte as Dicas de autenticação padrão.

No corpo da atividade

To build your project and enable the Object Wizard in other activities, you must use the Connection Wizard by clicking the Configure button.

Para saber mais, consulte a seção Assistentes na página Sobre .

Propriedades

Autenticação

• Username - The username for your ServiceNow instance. Enter a String variable.
  • Esse valor pode ser diferente de sua conta ServiceNow se você tiver várias instâncias.
  • O Nome de usuário está associado à Senha. É recomendável que você gere uma variável String seguindo a seção Criar ativos de credenciais do guia de Configuração .
  • Para inserir sua variável String , use uma atividade que gere seu ativo Credential (consulte o exemplo abaixo).
• Password - The password (associated with the Username) to your ServiceNow instance. Enter a String or String variable.
  • Esse valor pode ser diferente de sua conta ServiceNow se você tiver várias instâncias.
  • O Nome de usuário está associado à Senha. É recomendável que você gere uma variável String seguindo a seção Criar ativos de credenciais do guia de Configuração .
  • Para inserir sua variável String , use uma atividade que gere seu ativo Credential (consulte o exemplo abaixo).
• Client Secret - The SecureString used to authorize communications between UiPath and your ServiceNow instance. Enter a SecureString variable.
  • O ClientSecret é gerado para sua instância do ServiceNow quando você conclui um registro de aplicativo. Para obter mais informações, consulte a seção Configuração OAuth do guia de Configuração .
  • Para gerar uma variável SecureString , consulte a seção Criar ativos de credenciais do guia de Configuração .
  • Para inserir sua variável SecureString , use uma atividade que gere seu ativo Credential (consulte o exemplo abaixo).
• ClientId - The auto-generated, unique ID of your application registry. Enter a String variable.
  • O ClientId é gerado para sua instância do ServiceNow quando você conclui um registro de aplicativo. Para obter mais informações, consulte a seção Configuração OAuth do guia de Configuração .
  • O ClientId está associado ao ClientSecret. É recomendável que você gere uma variável String seguindo a seção Criar ativos de credenciais do guia de Configuração .
  • Para inserir sua variável String , use uma atividade que gere seu ativo Credential (consulte o exemplo abaixo).
• Porta local (opcional) — a porta local para redirecionamento. O valor padrão é 10001. Insira uma String ou uma variável String .
• Use OAuth 2.0 - Check this to use OAuth2 code grant flow of ServiceNow.

Comum

• DisplayName - The display name of the activity. Enter a String or String variable.

Conexão

• EndpointURL - The URL of your ServiceNow instance. Enter a String or String variable. The URL should be to your ServiceNow instance and not the Redirect URL in your application registry.

Diversos

• Privado - Se selecionado, os valores de variáveis e argumentos não são mais registrados no nível Verbose.

Opções

• ReportApiErrorAsException - When selected, API error responses are reported in BusinessActivityExecutionException by all child activities that use this application scope. When cleared, the child activity populates the API error message in the ResponseStatus output property and workflow execution continues. Check the ResponseStatus property to confirm successful execution.

Saída

• ServiceNowConnection - A record of your established connection that you can use in subsequent ServiceNow Application Scope activities. Enter a IConnection variable (UiPath.BAF.Models.Connection.IConnection).

Usar Conexão Existente

• ExistingServiceNowConnection - A connection record from a parent ServiceNow Application Scope activity that you can use instead of establishing a new connection. Enter a IConnection variable (UiPath.BAF.Models.Connection.IConnection).
  • The IConnection variable must be from a previously run SeriviceNow Scope activity (parent) that still has an active connection.
  • If you're unable to establish a connection using this property, try re-running your parent ServiceNow Application Scope activity.

Exemplo

A imagem a seguir mostra um exemplo do relacionamento de dependência de atividade e valores de propriedade de entrada/saída.

Para instruções passo a passo e exemplos, consulte o Guia de início rápido .

Dicas de autenticação padrão

No pacote de atividades ServiceNow, a autenticação básica (nome de usuário e senha) pode ser usada para executar atividades. As etapas são delineadas abaixo:

Tempo de projeto

Em Design Time, insira o nome de usuário e a senha com a URL do terminal e esses detalhes serão salvos. Observe que as credenciais não são validadas com o ServiceNow para autenticação básica no nível do escopo. Somente em um estágio posterior, quando as entidades do ServiceNow são buscadas em uma atividade individual ou no tempo de execução durante a execução de uma atividade, essas credenciais básicas de autenticação são usadas para autenticar.

Se as credenciais de autenticação básicas fornecidas estiverem incorretas, ao carregar a lista de entidades, será gerado um erro, pois ela usa as credenciais de autenticação básicas salvas para se conectar ao ServiceNow e obter nomes de entidades/tabelas.

If the credentials (Username, Password, EndpointUrl) are correct the entities will be populated in the activity dropdown like below:

Runtime

Certifique-se de que as credenciais sejam preenchidas no painel de propriedades à direita.

Se as credenciais estiverem corretas, a atividade será executada. Se incorreto, lançará um erro em tempo de execução, conforme mostrado abaixo: