XMLStreamingAPI – Umfang

  • Freigeben Version: Zurich
  • Aktualisiert 31. Juli 2025
  • 14 Minuten Lesedauer
  • Erstellt eine große XML-Streamingnutzlast zur Verwendung in einer REST- oder SOAP-Anforderung, um Massendaten an eine Drittanbieter-API zu senden. Sie können die Nutzlast auch als XML-Zeichenfolge für eine nicht-Streaming-Option erstellen.

    Verwenden Sie diese Methoden in einem Workflow-Studio Skriptschritt mit sn_ih Namespace-Bezeichner. Sie können diese API beispielsweise verwenden, um eine XML-Nutzlast in zu erstellen Workflow-Studio Skriptschritt und übergeben Sie den zurückgegebenen Wert an den REST-Schritt, um die Anforderung an einen Drittparteiservice zu senden. Weitere Informationen finden Sie unter Workflow-Studio Skriptschritt .
    Hinweis:
    Sie können diese API nur innerhalb von verwenden Workflow-Studio Umgebung.

    Für diese Klasse ist kein Konstruktor vorhanden. Stattdessen müssen Sie anrufen Build() Methode in XMLStreamingBuilder Klasse, um ein XMLStreamingAPI-Objekt zurückzugeben.

    API-Aufrufreihenfolge

    Generieren Sie XML-Nutzlasten, indem Sie zuerst ein Builder-Objekt mit instanziieren XMLStreamingBuilder Und ruft dann die Methoden in auf XMLStreamingAPI Klasse:

    1. XMLStreamingBuilder : Erstellt ein Generatorobjekt
    Verwenden Sie diese Methode in der folgenden Reihenfolge, um ein Generatorobjekt zu erstellen:
    1. XMLStreamingBuilder() : Instanziiert das XMLStreamingBuilder-Objekt.
    2. Mit Anhang() : Optional. Erstellt ein XML-Dokument als Anhang und speichert es in der Tabelle „Streaming-Anhänge“ [Streaming_attachment]. Wenn Sie diese Methode nicht aufrufen, erstellt die API die Nutzlast als XML-Zeichenfolge.
    3. ExpresAt() : Optional. Legt einen Zeitpunkt fest, zu dem der Anhang abläuft. „Falsch“ ist der Standard. Muss auch anrufen Mit Anhang() Methode.
    4. Build() : Gibt ein XMLStreamingAPI-Objekt zurück.
    2. XMLStreamingAPI : Erstellt die XML-Nutzlast
    Verwenden Sie diese Methoden in der folgenden Reihenfolge, um die XML-Nutzlast zu erstellen:
    1. StartDocument() : Erstellt das übergeordnete Element der obersten Ebene im XML-Dokument.
    2. Methoden zum Generieren untergeordneter Elemente im XML-Dokument, z. B. WriteTextElement() , StartElement() , Und WriteArray() .
    3. Methoden zum Generieren von Attributen für ein Element, z. B. WriteAttribute() , WriteNamespace() , Und WriteDtd() .
    4. EndElement() : Schließt ein XML-Element.
    5. EndDokument : Schließt das übergeordnete Element der obersten Ebene.
    6. GetXMLString() Oder GetAttachmentId() : Gibt die von Ihnen erstellte XML-Zeichenfolge oder Anhang-ID zurück.
    7. Schließen () : Schließt das XMLStreamingAPI-Objekt.

    Größenbeschränkungen

    Über diese API generierte Nutzlasten dürfen diese Größenbeschränkungen nicht überschreiten:

    • Anhänge: 200 MB
    • Zeichenfolgen: 5 MB

    Das folgende Beispiel zeigt, wie ein XML-Dokument erstellt und in der Tabelle „Streaming-Anhänge“ [Streaming_attachment] mit einem definierten Ablaufdatum gespeichert wird.

    
    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();
    }

    Alternativ zeigt dieses Beispiel, wie Sie die API im Skriptschritt verwenden und die Nutzlast als XML-Zeichenfolge erstellen. Sie können diese Option verwenden, um Nutzlasten unter zu erstellen 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);

    Ausgabe:

    <?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>

    XMLStreamingAPI – close()

    Schließt das XMLStreamingAPI-Objekt. Sie müssen diese Methode aufrufen, um den Stream nach der Erstellung Ihres XML-Dokuments zu schließen.

    Tabelle : 1. Parameter
    Name Typ Beschreibung
    Keine
    Tabelle : 2. Ergebnisse
    Typ Beschreibung
    void

    Beispiel

    Das folgende Beispiel zeigt, wie ein XML-Dokument erstellt und in der Tabelle „Streaming-Anhänge“ [Streaming_attachment] mit einem definierten Ablaufdatum gespeichert wird.

    
    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();
    }

    XMLStreamingAPI – disablePrettyPrint()

    Beendet die XML-Formatierung für den hübschen Druck.

    Bevor Sie diese Methode aufrufen, müssen Sie zuerst anrufen EnablePrettyPrint() Zum Hinzufügen einer XML-Formatierung zu einem Abschnitt.

    Tabelle : 3. Parameter
    Name Typ Beschreibung
    Keine
    Tabelle : 4. Ergebnisse
    Typ Beschreibung
    XMLStreamingAPI Streaming-XML-Objekt zum Erstellen der Nutzlast.

    Das folgende Beispiel zeigt, wie Sie dem eine hübsche Druckformatierung hinzufügen Adresse Element.

    try {
      var ttl = new GlideDateTime("2011-01-01 12:00:00");
      var builder = new sn_ih.XMLStreamingBuilder()
        .withAttachment()
        .expiresAt(ttl)
        .build();
    
      builder.startDocument("Employee")
        .writeTextElement("firstName","John")
        .writeTextElement("lastName","Smith")
        .writeTextElement("age","25")
        .enablePrettyPrint()
        .startElement("address")
          .writeTextElement("streetAddress", "21 2nd Street")
          .writeTextElement("city", "Santa Clara")
          .writeTextElement("state", "CA")
          .writeTextElement("postalCode", "11111")
        .endElement()
        .disablePrettyPrint()
        .startElement("phoneNumber")
          .writeTextElement("type","home")
          .writeTextElement("number","212 555-1234")
          .writeTextElement("type","fax")
          .writeTextElement("number","646 555-4567")
        .endElement()
      .endDocument()
          
      gs.log(builder.getAttachmentId());
    } catch (err) {
      gs.log(err);
    } finally {
      builder.close();
    }

    XMLStreamingAPI – enablePrettyPrint()

    Fügt einem XML-Element oder einer Struktur von Elementen eine hübsche Druckformatierung hinzu.

    Verwenden Sie DeaktivierenPrettyPrint() Methode zum Beenden der Formatierung.

    Tabelle : 5. Parameter
    Name Typ Beschreibung
    Keine
    Tabelle : 6. Ergebnisse
    Typ Beschreibung
    XMLStreamingAPI Streaming-XML-Objekt zum Erstellen der Nutzlast.

    Das folgende Beispiel zeigt, wie Sie dem eine hübsche Druckformatierung hinzufügen Adresse Element.

    try {
      var ttl = new GlideDateTime("2011-01-01 12:00:00");
      var builder = new sn_ih.XMLStreamingBuilder()
        .withAttachment()
        .expiresAt(ttl)
        .build();
    
      builder.startDocument("Employee")
        .writeTextElement("firstName","John")
        .writeTextElement("lastName","Smith")
        .writeTextElement("age","25")
        .enablePrettyPrint()
        .startElement("address")
          .writeTextElement("streetAddress", "21 2nd Street")
          .writeTextElement("city", "Santa Clara")
          .writeTextElement("state", "CA")
          .writeTextElement("postalCode", "11111")
        .endElement()
        .disablePrettyPrint()
        .startElement("phoneNumber")
          .writeTextElement("type","home")
          .writeTextElement("number","212 555-1234")
          .writeTextElement("type","fax")
          .writeTextElement("number","646 555-4567")
        .endElement()
      .endDocument()
          
      gs.log(builder.getAttachmentId());
    } catch (err) {
      gs.log(err);
    } finally {
      builder.close();
    }

    XMLStreamingAPI – endDocument()

    Beendet die Struktur Ihres XML-Dokuments.

    Nach dem Aufruf von StartDocument() Rufen Sie die Methode und Organisation Ihres XML-Streaming-Dokuments auf EndDocument() Methode am Ende der Dokumentstruktur. Sie müssen diese beiden Methoden zusammen verwenden, um die Struktur Ihres Streaming-XML-Dokuments erfolgreich zu erstellen.

    Tabelle : 7. Parameter
    Name Typ Beschreibung
    Keine
    Tabelle : 8. Ergebnisse
    Typ Beschreibung
    XMLStreamingAPI Streaming-XML-Objekt zum Erstellen der Nutzlast.

    Das folgende Beispiel zeigt, wie ein XML-Dokument erstellt wird, das Elemente zu einem Anwender enthält.

    try {
        var ttl = new GlideDateTime('2011-01-01 12:00:00');
        var builder = new sn_ih.XMLStreamingBuilder().withAttachment().expiresAt(ttl);
        var streamingDocument = builder.build();
    
        streamingDocument.startDocument('Employee')
            .writeTextElement('firstName', 'John')
            .writeTextElement('lastName', 'Smith')
            .writeTextElement('age', '25')
            .endDocument();
        gs.log(streamingDocument.getAttachmentId());
    } catch (err) {
        gs.log(err);
    } finally {
        streamingDocument.close();
    }

    XMLStreamingAPI – endElement()

    Fügt einem XML-Element ein schließendes Tag hinzu.

    Verwenden Sie die folgenden Methoden in dieser Reihenfolge, um ein gültiges XML-Element zu erstellen:
    1. Verwenden Sie StartElement() Methode zum Hinzufügen eines Start-Tags.
    2. Verwenden Sie EndElement() Methode zum Hinzufügen des schließenden Tags.
    Tabelle : 9. Parameter
    Name Typ Beschreibung
    Keine
    Tabelle : 10. Ergebnisse
    Typ Beschreibung
    XMLStreamingAPI Streaming-XML-Objekt zum Erstellen der Nutzlast.

    Das folgende Beispiel zeigt, wie ein übergeordnetes Element namens erstellt wird Adresse Und schreiben Sie dann vier untergeordnete Elemente.

    try {
      var ttl = new GlideDateTime("2011-01-01 12:00:00");
      var builder = new sn_ih.XMLStreamingBuilder()
        .withAttachment()
        .expiresAt(ttl)
        .build();
    
      builder.startDocument("Employee")
          .startElement("address")
          .writeTextElement("streetAddress", "21 2nd Street")
          .writeTextElement("city", "Santa Clara")
          .writeTextElement("state", "CA")
          .writeTextElement("postalCode", "11111")
        .endElement()
      .endDocument()
          
      gs.log(builder.getAttachmentId());
    } catch (err) {
      gs.log(err);
    } finally {
      builder.close();
    }

    XMLStreamingAPI – getXMLString()

    Gibt das XML-Dokument als Zeichenfolge zurück.

    Um das XML-Dokument als Zeichenfolge zurückzugeben, rufen Sie nicht auf GetAttachementId() Methode in XMLStreamingBuilder Klasse. Weitere Informationen finden Sie unter XMLStreamingBuilder: Bereichsbezogen .

    Tabelle : 11. Parameter
    Name Typ Beschreibung
    Keine
    Tabelle : 12. Ergebnisse
    Typ Beschreibung
    Zeichenfolge XML-Dokument, das mit erstellt wurde XMLStreamingAPI Methoden als Zeichenfolge.

    Das folgende Beispiel zeigt, wie ein XML-Dokument erstellt und dann als Zeichenfolge zurückgegeben wird.

    (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);

    Ausgabe:

    <?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>

    XMLStreamingAPI – startDocument(Zeichenfolge RootElement, Object namespaceDefinitionMap)

    Beginnt mit der Erstellung eines XML-Dokuments.

    Nach dem Aufruf von Build() Methode, rufen Sie auf StartDocument() Methode zum Starten der Organisation Ihres XML-Dokuments. Sie müssen auch anrufen EndDokument Methode am Ende der Dokumentstruktur.

    Tabelle : 13. Parameter
    Name Typ Beschreibung
    RootElement Zeichenfolge Optional. Stammelement oder übergeordnetes Element der obersten Ebene für Ihr XML-Dokument.
    NamespaceDefinitionMap Objekt Optional. Zuordnung von Schlüsseln und Werten für die Namespaces und die zugehörigen Werte in einer nachfolgenden Liste von Elementen. Zum Beispiel:
    {
    'namespaceOne':'namespaceValue',
    'namespaceTwo':'namespaceValue'
    }
    Tabelle : 14. Rückgaben
    Typ Beschreibung
    XMLStreamingAPI Streaming-XML-Objekt zum Erstellen der Nutzlast.

    Das folgende Beispiel zeigt, wie ein XML-Dokument erstellt wird, das Elemente mit Informationen zu einem Mitarbeiter enthält.

    try {
        var ttl = new GlideDateTime('2011-01-01 12:00:00');
        var builder = new sn_ih.XMLStreamingBuilder().withAttachment().expiresAt(ttl);
        var streamingDocument = builder.build();
    
        streamingDocument.startDocument('Employee')
            .writeTextElement('firstName', 'John')
            .writeTextElement('lastName', 'Smith')
            .writeTextElement('age', '25')
            .endDocument();
        gs.log(streamingDocument.getAttachmentId());
    } catch (err) {
        gs.log(err);
    } finally {
        streamingDocument.close();
    }

    XMLStreamingAPI – startElement(Zeichenfolgenname, Object namespaceMap, Object attributeMap, Zeichenfolgenpräfix)

    Fügt ein Start-Tag für ein XML-Element hinzu.

    Verwenden Sie die folgenden Methoden in dieser Reihenfolge, um ein gültiges XML-Element zu erstellen:
    1. Verwenden Sie StartElement() Methode zum Hinzufügen eines Start-Tags.
    2. Verwenden Sie EndElement() Methode zum Hinzufügen des schließenden Tags.
    Tabelle : 15. Parameter
    Name Typ Beschreibung
    Name Zeichenfolge Name des XML-Elements.
    NamespaceMap Objekt Optional. Zuordnung von Schlüsseln und Werten für die Namespaces und die zugehörigen Werte in einer nachfolgenden Liste von Elementen. Zum Beispiel:
    {
    'namespaceOne':'namespaceValue',
    'namespaceTwo':'namespaceValue'
    }
    AttributeMap Objekt Optional. Zuordnung von Schlüsseln und Werten für die Attribute und die zugehörigen Werte in einer nachfolgenden Liste von Elementen.
    Präfix Zeichenfolge Optional. Präfix für das XML-Element.
    Tabelle : 16. Rückgaben
    Typ Beschreibung
    XMLStreamingAPI Streaming-XML-Objekt zum Erstellen der Nutzlast.

    Das folgende Beispiel zeigt, wie ein übergeordnetes Element namens erstellt wird Adresse Und schreiben Sie dann vier untergeordnete Elemente.

    try {
      var ttl = new GlideDateTime("2011-01-01 12:00:00");
      var builder = new sn_ih.XMLStreamingBuilder()
        .withAttachment()
        .expiresAt(ttl)
        .build();
    
      builder.startDocument("Employee")
          .startElement("address")
          .writeTextElement("streetAddress", "21 2nd Street")
          .writeTextElement("city", "Santa Clara")
          .writeTextElement("state", "CA")
          .writeTextElement("postalCode", "11111")
        .endElement()
      .endDocument()
          
      gs.log(builder.getAttachmentId());
    } catch (err) {
      gs.log(err);
    } finally {
      builder.close();
    }

    XMLStreamingAPI – writeArray(String elementName, Array-Daten, String wrappingElement)

    Fügt Ihrem Streaming-XML-Dokument eine Liste geschachtelter Elemente mit vordefiniertem Text hinzu.

    Nach dem Aufruf von StartDocument() -Methode können Sie aufrufen WriteArray() Methode zum Hinzufügen eines Blocks geschachtelter Elemente zu Ihrem Streaming-XML-Dokument.

    Tabelle : 17. Parameter
    Name Typ Beschreibung
    Elementname Zeichenfolge Name des XML-Elements, das jeder in aufgeführten Zeichenfolge zugeordnet ist dataArray.
    Daten Array Liste der Werte, die jedem darin geschachtelten Element zugewiesen werden sollen wrappingElement.
    WrappingElement Zeichenfolge Übergeordnetes Element, das jedes enthält elementName.
    Tabelle : 18. Rückgaben
    Typ Beschreibung
    XMLStreamingAPI Streaming-XML-Objekt zum Erstellen der Nutzlast.

    Das folgende Beispiel zeigt, wie ein übergeordnetes Element namens erstellt wird Bürostandorte , Und verschachteln Sie dann ein Array von fünf Stadt Elemente.

    try {
      var ttl = new GlideDateTime("2011-01-01 12:00:00");
      var builder = new sn_ih.XMLStreamingBuilder()
        .withAttachment()
        .expiresAt(ttl)
        .build();
    
      builder.startDocument("Employee")
          .writeArray('city', ['Santa Clara','San Diego','Chicago','Sydney','London'], 'officeLocations')
      .endDocument()
          
      gs.log(builder.getAttachmentId());
    } catch (err) {
      gs.log(err);
    } finally {
      builder.close();
    }

    XMLStreamingAPI – writeAttribute (Zeichenfolgenname, Zeichenfolgenwert)

    Fügt einem Element in Ihrem XML-Dokument ein Attribut hinzu.

    Nach dem Aufruf von StartDocument() , StartElement() , Oder WriteTextElement() -Methode können Sie aufrufen WriteAttribute() Methode zum Hinzufügen eines Attributs zum zugeordneten XML-Element.

    Tabelle : 19. Parameter
    Name Typ Beschreibung
    Name Zeichenfolge Name des Attributs des XML-Elements.
    Wert Zeichenfolge Wert für das Attribut des XML-Elements.
    Tabelle : 20. Rückgaben
    Typ Beschreibung
    XMLStreamingAPI Streaming-XML-Objekt zum Erstellen der Nutzlast.

    In diesem Beispiel wird ein Attribut mit dem Namen hinzugefügt IDNummer Zu Mitarbeiter Element.

    try {
        var ttl = new GlideDateTime('2011-01-01 12:00:00');
        var builder = new sn_ih.XMLStreamingBuilder().withAttachment().expiresAt(ttl);
        var streamingDocument = builder.build();
    
        streamingDocument.startDocument('Employee')
        .writeAttribute('idNumber','12345')
            .writeTextElement('firstName', 'John')
            .writeTextElement('lastName', 'Smith')
            .writeTextElement('age', '25')
        .endDocument();
        gs.log(streamingDocument.getAttachmentId());
    } catch (err) {
        gs.log(err);
    } finally {
        streamingDocument.close();
    }

    XMLStreamingAPI – writeAttributes(Object attributeMap)

    Fügt einem Element in Ihrem XML-Dokument Attribute hinzu.

    Nach dem Aufruf von StartDocument() , StartElement() , Oder WriteTextElement() -Methode können Sie aufrufen WriteAttributes() Methode zum Hinzufügen von Attributen zum zugeordneten XML-Element.

    Tabelle : 21. Parameter
    Name Typ Beschreibung
    AttributeMap Objekt Zuordnung von Schlüsseln und Werten, die Attributnamen und -Werte enthalten, die dem XML-Element zugeordnet werden sollen. Zum Beispiel:
    {
    'attributeOne':'attributeValue',
    'attributeTwo':'attributeValue'
    }
    Tabelle : 22. Rückgaben
    Typ Beschreibung
    XMLStreamingAPI Streaming-XML-Objekt zum Erstellen der Nutzlast.

    In diesem Beispiel werden Attribute mit dem Namen hinzugefügt IDNummer , Bürostandort , Und Abteilung Zu Mitarbeiter Element.

    try {
        var ttl = new GlideDateTime('2011-01-01 12:00:00');
        var builder = new sn_ih.XMLStreamingBuilder().withAttachment().expiresAt(ttl);
        var streamingDocument = builder.build();
    
        streamingDocument.startDocument('Employee')
        .writeAttributes({'idNumber':'12345', 'officeLocation':'San Diego', 'department':'Sales'})
            .writeTextElement('firstName', 'John')
            .writeTextElement('lastName', 'Smith')
            .writeTextElement('age', '25')
        .endDocument();
        gs.log(streamingDocument.getAttachmentId());
    } catch (err) {
        gs.log(err);
    } finally {
        streamingDocument.close();
    }

    XMLStreamingAPI – writeCData (Zeichenfolgendaten)

    Fügt Ihrem XML-Dokument CDATA hinzu.

    Nach dem Aufruf von WriteCDataElement() -Methode können Sie aufrufen WriteCData() Methode zum Hinzufügen von CDATA innerhalb des Elements.

    Tabelle : 23. Parameter
    Name Typ Beschreibung
    data Zeichenfolge Wert, der nach dem CDATA-Stichwort in Ihr CDATA-Element aufgenommen werden soll.
    Tabelle : 24. Rückgaben
    Typ Beschreibung
    XMLStreamingAPI Streaming-XML-Objekt zum Erstellen der Nutzlast.

    In diesem Beispiel wird dem CDATA-Element CDATA hinzugefügt Zeitverarbeitungszeit .

    try {
        var ttl = new GlideDateTime('2011-01-01 12:00:00');
        var builder = new sn_ih.XMLStreamingBuilder().withAttachment().expiresAt(ttl);
        var streamingDocument = builder.build();
    
        streamingDocument.startDocument('Employee')
            .writeTextElement('firstName', 'John')
            .writeTextElement('lastName', 'Smith')
            .writeTextElement('age', '25')
            .writeCDataElement('timeWorked')
            .writeCData('< 2 years')
        .endDocument();
        gs.log(streamingDocument.getAttachmentId());
    } catch (err) {
        gs.log(err);
    } finally {
        streamingDocument.close();
    }

    XMLStreamingAPI – writeCDataElement (Zeichenfolgenname, Zeichenfolgendaten, Objektpräfix)

    Fügt Ihrem XML-Dokument ein CDATA-Element hinzu.

    Nach dem Aufruf von StartDocument() -Methode können Sie aufrufen WriteCDataElement() Methode zum Hinzufügen eines CDATA-Elements zu Ihrem XML-Dokument.

    Tabelle : 25. Parameter
    Name Typ Beschreibung
    Name Zeichenfolge Name des CDATA-Elements.
    Daten Zeichenfolge Optional. Typ der Daten, als die das CDATA-Element analysiert werden soll.
    Präfix Objekt Optional. Zuordnung der untergeordneten Elemente und Werte, die das CDATA-Element enthält. Zum Beispiel:
    {
    'prefixOne':'prefixValue',
    'prefixTwo':'prefixValue'
    }
    Sie müssen das Präfix eines XML-Elements mit einem Namespace zuordnen WriteNamespace() .
    Tabelle : 26. Rückgaben
    Typ Beschreibung
    XMLStreamingAPI Streaming-XML-Objekt zum Erstellen der Nutzlast.

    In diesem Beispiel wird eine Dokumenttypdefinition mit dem Namen verwendet Adresse Zum Definieren einer internen Dokumenttypdefinition für das XML-Dokument.

    try {
      var ttl = new GlideDateTime("2011-01-01 12:00:00");
      var builder = new sn_ih.XMLStreamingBuilder()
        .withAttachment()
        .expiresAt(ttl)
        .build();
    
      builder.startDocument("Employee")
      .writeDtd('address')
      .writeCDataElement('home', '#PCDATA', {'streetAddress', 'city', 'state', 'postalCode'})
          .writeTextElement("streetAddress", "21 2nd Street")
          .writeTextElement("city", "Santa Clara")
          .writeTextElement("state", "CA")
          .writeTextElement("postalCode", "11111")
      .endDocument()
          
      gs.log(builder.getAttachmentId());
    } catch (err) {
      gs.log(err);
    } finally {
      builder.close();
    }

    XMLStreamingAPI – writeCharacters (Zeichenfolgentext)

    Fügt Ihrem XML-Dokument Text hinzu.

    Verwenden Sie WriteCharacters() Methode zum Einfügen von Zeichenfolgendaten in einen Abschnitt in Ihrem XML-Dokument.

    Tabelle : 27. Parameter
    Name Typ Beschreibung
    text Zeichenfolge Text, der einem Abschnitt Ihres XML-Dokuments hinzugefügt werden soll.
    Tabelle : 28. Rückgaben
    Typ Beschreibung
    XMLStreamingAPI Streaming-XML-Objekt zum Erstellen der Nutzlast.

    Das folgende Beispiel zeigt, wie Sie Elementen in Ihrem XML-Dokument Textwerte hinzufügen.

    try {
        var ttl = new GlideDateTime('2011-01-01 12:00:00');
        var builder = new sn_ih.XMLStreamingBuilder().withAttachment().expiresAt(ttl);
        var streamingDocument = builder.build();
    
        streamingDocument.startDocument('Employee')
            .startElement('firstName')
            .writeCharacters('John')
            .EndElement()
            .startElement('lastName')
            .writeCharacters('Smith')
            .endElement()
        .endDocument();
        gs.log(streamingDocument.getAttachmentId());
    } catch (err) {
        gs.log(err);
    } finally {
        streamingDocument.close();
    }

    XMLStreamingAPI – writeComment(Zeichenfolgenkommentar)

    Fügt Ihrem XML-Dokument einen Kommentar hinzu.

    Nach dem Aufruf von StartDocument() -Methode können Sie aufrufen WriteComment() Methode zum Hinzufügen eines Kommentars zu Ihrem XML-Dokument.

    Tabelle : 29. Parameter
    Name Typ Beschreibung
    Kommentar Zeichenfolge Einzubeziehender Kommentartext.
    Tabelle : 30. Rückgaben
    Typ Beschreibung
    XMLStreamingAPI Streaming-XML-Objekt zum Erstellen der Nutzlast.

    Das folgende Beispiel zeigt, wie einem XML-Dokument ein Kommentar hinzugefügt wird.

    try {
        var ttl = new GlideDateTime('2011-01-01 12:00:00');
        var builder = new sn_ih.XMLStreamingBuilder().withAttachment().expiresAt(ttl);
        var streamingDocument = builder.build();
    
        streamingDocument.startDocument('Employee')
            .writeComment('Element for information related to active employees.')
            .writeTextElement('firstName', 'John')
            .writeTextElement('lastName', 'Smith')
            .writeTextElement('age', '25')
        .endDocument();
        gs.log(streamingDocument.getAttachmentId());
    } catch (err) {
        gs.log(err);
    } finally {
        streamingDocument.close();
    }

    XMLStreamingAPI – writeDtd(Zeichenfolge dtd)

    Fügt Ihrem XML-Dokument eine Dokumenttypdefinition hinzu.

    Nach dem Aufruf von StartDocument() -Methode können Sie aufrufen WriteDtd() Methode zum Hinzufügen einer gültigen XML-Dokumenttypdefinition zu Ihrem XML-Dokument.

    Tabelle : 31. Parameter
    Name Typ Beschreibung
    dtd Zeichenfolge Name einer gültigen XML-Dokumenttypdefinition.
    Tabelle : 32. Rückgaben
    Typ Beschreibung
    XMLStreamingAPI Streaming-XML-Objekt zum Erstellen der Nutzlast.

    In diesem Beispiel wird eine Dokumenttypdefinition mit dem Namen verwendet Adresse Zum Definieren einer internen Dokumenttypdefinition für das XML-Dokument.

    try {
      var ttl = new GlideDateTime("2011-01-01 12:00:00");
      var builder = new sn_ih.XMLStreamingBuilder()
        .withAttachment()
        .expiresAt(ttl)
        .build();
    
      builder.startDocument("Employee")
      .writeDtd('address')
      .writeCDataElement('home', '#PCDATA', {'streetAddress', 'city', 'state', 'postalCode'})
          .writeTextElement("streetAddress", "21 2nd Street")
          .writeTextElement("city", "Santa Clara")
          .writeTextElement("state", "CA")
          .writeTextElement("postalCode", "11111")
      .endDocument()
          
      gs.log(builder.getAttachmentId());
    } catch (err) {
      gs.log(err);
    } finally {
      builder.close();
    }

    XMLStreamingAPI – writeNamespace(Zeichenfolgenpräfix, ZeichenfolgennamespaceURI)

    Fügt einem Element in Ihrem XML-Dokument einen Namespace hinzu.

    Nach dem Aufruf von StartDocument() , StartElement() , Oder WriteTextElement() -Methode können Sie aufrufen WriteNamespace() Methode zum Hinzufügen eines Namespace zum zugehörigen XML-Element.

    Tabelle : 33. Parameter
    Name Typ Beschreibung
    Präfix Zeichenfolge Präfix für den XML-Namespace.
    NamespaceURI Zeichenfolge Optional. URI für den Namespace.
    Tabelle : 34. Rückgaben
    Typ Beschreibung
    XMLStreamingAPI Streaming-XML-Objekt zum Erstellen der Nutzlast.

    Das folgende Beispiel zeigt, wie ein Namespace und ein URI zu hinzugefügt werden Unternehmen Stammelement und weisen Sie dann das Präfix dem geschachtelten zu Unternehmensname Element.

    try {
        var ttl = new GlideDateTime('2011-01-01 12:00:00');
        var builder = new sn_ih.XMLStreamingBuilder().withAttachment().expiresAt(ttl);
        var streamingDocument = builder.build();
    
        streamingDocument.startDocument('company')
        .writeNamespace('x','https://www.servicenow.com')
            .writeTextElement('companyName', 'ServiceNow')
            .writeNamespace('x')
        .endDocument();
        gs.log(streamingDocument.getAttachmentId());
    } catch (err) {
        gs.log(err);
    } finally {
        streamingDocument.close();
    }

    XMLStreamingAPI – writeNamespaces(Object namespaceMap)

    Fügt dem Stamm Namespaces hinzu Element in Ihr XML-Dokument.

    Nach dem Aufruf von StartDocument() Oder StartElement() -Methode können Sie aufrufen WriteNamespaces() Methode zum Deklardieren von Namespaces für das zugeordnete XML-Element.

    Tabelle : 35. Parameter
    Name Typ Beschreibung
    NamespaceMap Objekt Zuordnung von Schlüsseln und Werten mit Namespace-Präfixen und URIs, die dem Stammelement von zugeordnet werden sollen XML Dokument. Zum Beispiel:
    {
    'namespaceOne':'namespaceValue',
    'namespaceTwo':'namespaceValue'
    }
    Tabelle : 36. Rückgaben
    Typ Beschreibung
    XMLStreamingAPI Streaming-XML-Objekt zum Erstellen der Nutzlast.

    In diesem Beispiel werden zwei Namespaces und URIs zur hinzugefügt Unternehmen Stammelement und weist den geschachtelten Elementen dann die entsprechenden Präfixe zu.

    try {
        var ttl = new GlideDateTime('2011-01-01 12:00:00');
        var builder = new sn_ih.XMLStreamingBuilder().withAttachment().expiresAt(ttl);
        var streamingDocument = builder.build();
    
        streamingDocument.startDocument('company')
        .writeNamespaces({'x':'https://www.servicenow.com', 'y':'https://www.developer.servicenow.com'})
            .writeTextElement('companyName', 'ServiceNow')
            .writeNamespace('x')
            .writeTextElement('devFramework', 'UI Framework')
            .writeNamespace('y')
        .endDocument();
        gs.log(streamingDocument.getAttachmentId());
    } catch (err) {
        gs.log(err);
    } finally {
        streamingDocument.close();
    }

    XMLStreamingAPI – writeTextElement (Zeichenfolgenname, Zeichenfolgentext, Objektpräfix)

    Fügt Ihrem XML-Dokument ein einzelnes XML-Element hinzu.

    Nach dem Aufruf von StartDocument() -Methode können Sie aufrufen WriteTextElement() Methode zum Hinzufügen eines einzelnen XML-Elements zur Struktur Ihres XML-Dokuments.

    Tabelle : 37. Parameter
    Name Typ Beschreibung
    Name Zeichenfolge Name des XML-Elements.
    text Zeichenfolge Wert für das XML-Element.
    Präfix Objekt Optional. Zuordnung der Präfixe und Werte, die dem XML-Element zugeordnet sind. Zum Beispiel:
    {
    'prefixOne':'prefixValue',
    'prefixTwo':'prefixValue'
    }
    Sie müssen das Präfix eines XML-Elements mit einem Namespace zuordnen WriteNamespace() .
    Tabelle : 38. Rückgaben
    Typ Beschreibung
    XMLStreamingAPI Streaming-XML-Objekt zum Erstellen der Nutzlast.

    Das folgende Beispiel zeigt, wie ein XML-Dokument erstellt wird, das drei Elemente mit Informationen zu einem Mitarbeiter enthält.

    try {
        var ttl = new GlideDateTime('2011-01-01 12:00:00');
        var builder = new sn_ih.XMLStreamingBuilder().withAttachment().expiresAt(ttl);
        var streamingDocument = builder.build();
    
        streamingDocument.startDocument('Employee')
            .writeTextElement('firstName', 'John')
            .writeTextElement('lastName', 'Smith')
            .writeTextElement('age', '25')
        .endDocument();
        gs.log(streamingDocument.getAttachmentId());
    } catch (err) {
        gs.log(err);
    } finally {
        streamingDocument.close();
    }