Search Results for

    Show / Hide Table of Contents

    Export Template from Peoplevox

    This task allows you to export any template configured on your Peoplevox instance, and control the format of the output XML file.

    Connection Settings

    Peoplevox Connection

    Required
    The connection to the Peoplevox instance to use. See the Connecting to Peoplevox if you require more information on how to create/manage connections.

    Export Settings

    Timeout (In Minutes)

    Required
    Maximum amount of time in minutes that Zynk will wait for a response per call made. Defaults to 10.

    File Settings

    Output File

    Required
    The name or full path to the file the returned data will be saved to.

    Defaults to peoplevox_export_template.xml

    Peoplevox Settings

    API Call Delay

    Required
    The number of seconds to wait between sending requests to the Peoplevox API, used when making multiple paged requests to export data. Defaults to 1.

    Items Per Page

    Required
    The number of items to retrieve per request made to Peoplevox. Zynk will make as many requests as required to download all data matching the filters set on the task. The maximum this can be is 1000, anything higher will be reset to 1000. Defaults to 20.

    Search Clauses

    Optional
    You can add search clauses to limit the data that is returned from the report, for more information see Peoplevox Search Clauses.

    Xml Settings

    Export As Elements

    Required
    Set to False to export all information as attributes in the output XML file, this usually ends up with a smaller file size. Note, when using attributes in XSLT you must prepend the name of the field with @ e.g. @Item_code. Set to True to export all information as elements in the output XML file. Defaults to False.

    Root

    Required
    The name of the main root node of the output XML file, using this field you can customise the format of the output if required. Defaults to Rows.

    Row

    Required
    The name of each row created in the output XML file that relates to each record returned in the report, using this field you can customise the format of the output if required. Defaults to Row.

    Template

    Required
    Specify the template name to export from. Defaults to Carriers.

    XML Settings

    Export As Elements

    Required
    Setting to True will output fields as elements in the XML file, setting to False output the fields as attributes. Defaults to True.

    Root

    Required
    Used to specify the root element of the output XML file. Defaults to Carriers.

    Row

    Required
    Used to specify the name of the element for each record in the output file. Defaults to Carrier.

    Zynk Settings

    See Common Task Settings

    Example XML

    Example output file using the default task settings referencing the Carriers template.

    <?xml version="1.0" encoding="utf-8"?>
    <Carriers>
      <Carrier>
        <Name>DHL</Name>
        <Reference_x0020_2>D0001</Reference_x0020_2>
      </Carrier>
      <Carrier>
        <Name>FedEx</Name>
        <Reference_x0020_2> F0002</Reference_x0020_2>
      </Carrier>
      <Carrier>
        <Name>Joe Harrison</Name>
        <Reference_x0020_2 />
      </Carrier>
    </Carriers>
    
    In This Article
    Zynk Documentation © 2021, Zynk Software Limited. Zynk is a registered trademark of Zynk Software Limited