XMLStreamingBuilder - Com escopo

Cria um objeto de construtor para criar uma carga XML grande para uso em uma solicitação REST ou SOAP para enviar dados em massa para uma API de terceiros. Você também pode criar a carga como uma cadeia de caracteres XML para uma opção de não fluxo.

Use esses métodos em um Workflow Studio Etapa de script com sn_ih identificador de namespace. Por exemplo, você pode usar esta API para criar uma carga XML no Workflow Studio Etapa de script e passe o valor retornado para a etapa REST para enviar a solicitação a um serviço de terceiros. Para obter mais informações, consulte Workflow Studio Etapa de script .

Nota:

Você só pode usar esta API no Workflow Studio ambiente.

Ordem de chamada de API

Gere cargas XML primeiro instanciando um objeto do construtor com XMLStreamingBuilder e, em seguida, chamando os métodos no XMLStreamingAPI classe:

1. XMLStreamingBuilder Cria um objeto do construtor

Use este método na seguinte ordem para criar um objeto do construtor:

1. XMLStreamingBuilder() : Instancia o objeto XMLStreamingBuilder.
2. Com anexo () : Opcional. Cria um documento XML como um anexo e o armazena na tabela Anexos de fluxo [streaming_attachment]. Se você não chamar esse método, a API criará a carga como uma cadeia de caracteres XML.
3. ExpiresAt() : Opcional. Define um horário em que o anexo expira. Falso é o padrão. Também deve chamar Com anexo () método.
4. compilação () : Retorna um objeto XMLStreamingAPI.

2. XMLStreamingAPI Cria a carga XML

Use estes métodos na seguinte ordem para criar a carga XML:

1. StartDocument() : Cria o elemento primário de nível superior no documento XML.
2. Métodos para gerar elementos secundários no documento XML, como WriteTexElement() , StartElement() e WriteArray() .
3. Métodos para gerar atributos para um elemento, como WriteAttribute() , WriteNamespace() e WriteDtd() .
4. EndElement() : Fecha um elemento XML.
5. EndDocument : Fecha o elemento primário de nível superior.
6. GetXMLString() ou GetAttachmentId() Retorna a cadeia de caracteres XML ou o ID de anexo que você criou.
7. fechar() : Fecha o objeto XMLStreamingAPI.

Limites de tamanho

As cargas geradas por meio desta API não podem exceder estes limites de tamanho:

• Anexos: 200 MB
• Cadeias de caracteres: 5 MB

O exemplo a seguir mostra como criar um documento XML e armazená-lo na tabela Anexos de fluxo [streaming_attachment] com uma data de expiração definida.

try {
  var ttl = new GlideDateTime("2011-01-01 12:00:00");
  var builder = new sn_ih.XMLStreamingBuilder()
    .withAttachment() // Creates the XML document in streaming mode within an attachment.
    .expiresAt(ttl) // Sets an expiration date for the attachment.
    .build(); // Creates the XMLStreamingAPI object.

  builder.startDocument("Employee") // Begins generating the XML document.
    .writeTextElement("firstName","John") // Writes a "firstName" element and value.
    .writeTextElement("lastName","Smith")
    .writeTextElement("age","25")
    .startElement("address") // Adds an "address" parent element.
      .writeTextElement("streetAddress", "21 2nd Street") // Writes a child element and value.
      .writeTextElement("city", "Santa Clara")
      .writeTextElement("state", "CA")
      .writeTextElement("postalCode", "11111")
    .endElement() // Adds a closing tag for the "address" element.
    .startElement("phoneNumber")
      .writeTextElement("type","home")
      .writeTextElement("number","212 555-1234")
      .writeTextElement("type","fax")
      .writeTextElement("number","646 555-4567")
    .endElement()
  .endDocument() // Stops generating the XML document.
      
  gs.log(builder.getAttachmentId()); // Returns the sys_id of the attachment.
} catch (err) {
  gs.log(err);
} finally {
  builder.close();
}

Como alternativa, este exemplo mostra como usar a API na etapa Script e criar a carga como uma cadeia de caracteres XML. Você pode usar esta opção para criar cargas em 5 MB .

(function execute(inputs, outputs) {

  var builder = new sn_ih.XMLStreamingBuilder().build();
  
  builder.startDocument("Employee")
    .enablePrettyPrint()
    .writeTextElement("firstName","John")
    .writeTextElement("lastName","Smith")
    .writeTextElement("age","25")
    .startElement("address")
      .writeTextElement("streetAddress", "21 2nd Street")
      .writeTextElement("city", "Santa Clara")
      .writeTextElement("state", "CA")
      .writeTextElement("postalCode", "11111")
    .endElement()
    .startElement("phoneNumber")
      .writeTextElement("type","home")
      .writeTextElement("number","212 555-1234")
      .writeTextElement("type","fax")
      .writeTextElement("number","646 555-4567")
    .endElement()
  .endDocument()

  outputs.payload = builder.getXMLString();
  
})(inputs, outputs);

Saída:

<?xml version="1.0" encoding="UTF-8"?>
<firstName>John</firstName>
<lastName>Smith</lastName>
<age>25</age>
<address>
  <streetAddress>21 2nd Street</streetAddress>
  <city>Santa Clara</city>
  <state>CA</state>
  <postalCode>11111</postalCode>
</address>
<phoneNumber>
  <type>home</type>
  <number>212 555-1234</number>
  <type>fax</type>
  <number>646 555-4567</number>
</phoneNumber>

XMLStreamingBuilder - XMLStreamingBuilder()

Instancia o objeto XMLStreamingBuilder.

Tabela 1. Parâmetros

Nome	Tipo	Descrição
Nenhum(a)

Este exemplo mostra como instanciar um construtor objeto.

var builder = new sn_ih.XMLStreamingBuilder()

XMLStreamingBuilder - build()

Retorna um objeto XMLStreamingAPI.

Tabela 2. Parâmetros

Nome	Tipo	Descrição
Nenhum

Tabela 3. Retorna

Tipo	Descrição
XMLStreamingAPI	Fluxo de objeto XML para construir a carga.

O exemplo a seguir mostra como criar um documento XML e armazená-lo na tabela Anexos de fluxo [streaming_attachment] com uma data de expiração definida.

try {
  var ttl = new GlideDateTime("2011-01-01 12:00:00");
  var builder = new sn_ih.XMLStreamingBuilder()
    .withAttachment() // Creates the XML document in streaming mode within an attachment.
    .expiresAt(ttl) // Sets an expiration date for the attachment.
    .build(); // Creates the XMLStreamingAPI object.

  builder.startDocument("Employee") // Begins generating the XML document.
    .writeTextElement("firstName","John") // Writes a "firstName" element and value.
    .writeTextElement("lastName","Smith")
    .writeTextElement("age","25")
    .startElement("address") // Adds an "address" parent element.
      .writeTextElement("streetAddress", "21 2nd Street") // Writes a child element and value.
      .writeTextElement("city", "Santa Clara")
      .writeTextElement("state", "CA")
      .writeTextElement("postalCode", "11111")
    .endElement() // Adds a closing tag for the "address" element.
    .startElement("phoneNumber")
      .writeTextElement("type","home")
      .writeTextElement("number","212 555-1234")
      .writeTextElement("type","fax")
      .writeTextElement("number","646 555-4567")
    .endElement()
  .endDocument() // Stops generating the XML document.
      
  gs.log(builder.getAttachmentId()); // Returns the sys_id of the attachment.
} catch (err) {
  gs.log(err);
} finally {
  builder.close();
}

XMLStreamingBuilder - expiresAt(Object expiresAt)

Define um horário em que o anexo expira. Também deve chamar Com anexo () método.

Tabela 4. Parâmetros

Nome	Tipo	Descrição
dataExpiração	GlideDateTime	Objeto definido quando o anexo expira. Valor mínimo: 7200 segundos, ou duas horas, a partir do momento em que o anexo é criado. Este será o valor padrão se você não chamar ExpiresAt() método. Valor máximo: 172800 segundos, ou 48 horas, a partir do momento em que o anexo é criado.

Tabela 5. Retornos

Tipo	Descrição
XMLStreamingBuilder	Objeto do construtor usado para iniciar a carga XML.

O exemplo a seguir mostra como criar um documento XML e armazená-lo na tabela Anexos de fluxo [streaming_attachment] com uma data de expiração definida.

try {
  var ttl = new GlideDateTime("2011-01-01 12:00:00");
  var builder = new sn_ih.XMLStreamingBuilder()
    .withAttachment() // Creates the XML document in streaming mode within an attachment.
    .expiresAt(ttl) // Sets an expiration date for the attachment.
    .build(); // Creates the XMLStreamingAPI object.

  builder.startDocument("Employee") // Begins generating the XML document.
    .writeTextElement("firstName","John") // Writes a "firstName" element and value.
    .writeTextElement("lastName","Smith")
    .writeTextElement("age","25")
    .startElement("address") // Adds an "address" parent element.
      .writeTextElement("streetAddress", "21 2nd Street") // Writes a child element and value.
      .writeTextElement("city", "Santa Clara")
      .writeTextElement("state", "CA")
      .writeTextElement("postalCode", "11111")
    .endElement() // Adds a closing tag for the "address" element.
    .startElement("phoneNumber")
      .writeTextElement("type","home")
      .writeTextElement("number","212 555-1234")
      .writeTextElement("type","fax")
      .writeTextElement("number","646 555-4567")
    .endElement()
  .endDocument() // Stops generating the XML document.
      
  gs.log(builder.getAttachmentId()); // Returns the sys_id of the attachment.
} catch (err) {
  gs.log(err);
} finally {
  builder.close();
}

XMLStreamingBuilder - withAttachment()

Cria um documento XML como um anexo e o armazena na tabela Anexos de fluxo [streaming_attachment]. Se você não chamar esse método, a API criará o documento XML como uma cadeia de caracteres.

Tabela 6. Parâmetros

Nome	Tipo	Descrição
Nenhum

Tabela 7. Retorna

Tipo	Descrição
XMLStreamingBuilder	Objeto do construtor usado para iniciar a carga XML.

O exemplo a seguir mostra como criar um documento XML e armazená-lo na tabela Anexos de fluxo [streaming_attachment] com uma data de expiração definida.

try {
  var ttl = new GlideDateTime("2011-01-01 12:00:00");
  var builder = new sn_ih.XMLStreamingBuilder()
    .withAttachment() // Creates the XML document in streaming mode within an attachment.
    .expiresAt(ttl) // Sets an expiration date for the attachment.
    .build(); // Creates the XMLStreamingAPI object.

  builder.startDocument("Employee") // Begins generating the XML document.
    .writeTextElement("firstName","John") // Writes a "firstName" element and value.
    .writeTextElement("lastName","Smith")
    .writeTextElement("age","25")
    .startElement("address") // Adds an "address" parent element.
      .writeTextElement("streetAddress", "21 2nd Street") // Writes a child element and value.
      .writeTextElement("city", "Santa Clara")
      .writeTextElement("state", "CA")
      .writeTextElement("postalCode", "11111")
    .endElement() // Adds a closing tag for the "address" element.
    .startElement("phoneNumber")
      .writeTextElement("type","home")
      .writeTextElement("number","212 555-1234")
      .writeTextElement("type","fax")
      .writeTextElement("number","646 555-4567")
    .endElement()
  .endDocument() // Stops generating the XML document.
      
  gs.log(builder.getAttachmentId()); // Returns the sys_id of the attachment.
} catch (err) {
  gs.log(err);
} finally {
  builder.close();
}

Este exemplo mostra como criar a carga XML e salvá-la como uma cadeia de caracteres.

(function execute(inputs, outputs) {

  var builder = new sn_ih.XMLStreamingBuilder().build();
  
  builder.startDocument("Employee")
    .enablePrettyPrint()
    .writeTextElement("firstName","John")
    .writeTextElement("lastName","Smith")
    .writeTextElement("age","25")
    .startElement("address")
      .writeTextElement("streetAddress", "21 2nd Street")
      .writeTextElement("city", "Santa Clara")
      .writeTextElement("state", "CA")
      .writeTextElement("postalCode", "11111")
    .endElement()
    .startElement("phoneNumber")
      .writeTextElement("type","home")
      .writeTextElement("number","212 555-1234")
      .writeTextElement("type","fax")
      .writeTextElement("number","646 555-4567")
    .endElement()
  .endDocument()

  outputs.payload = builder.getXMLString();
  
})(inputs, outputs);

Saída:

<?xml version="1.0" encoding="UTF-8"?>
<firstName>John</firstName>
<lastName>Smith</lastName>
<age>25</age>
<address>
  <streetAddress>21 2nd Street</streetAddress>
  <city>Santa Clara</city>
  <state>CA</state>
  <postalCode>11111</postalCode>
</address>
<phoneNumber>
  <type>home</type>
  <number>212 555-1234</number>
  <type>fax</type>
  <number>646 555-4567</number>
</phoneNumber>