File Manager - Administration Guide : File Package Download

<Configuration id="cfg1">
    <!-- More configuration data here... -->
    <Access>
        <UserList>
            <User>person_TestEverything</User>
            <User>Test ManufacturingEngineer</User>
        </UserList>
    </Access>
    <!-- More configuration data here... -->
</Configuration>

<Configuration id="cfg1">
    <!-- More configuration data here... -->
    <Access>
        <RoleList>
            <Role>role_GlobalUser</Role>
        </RoleList>
    </Access>
    <!-- More configuration data here... -->
</Configuration>

<Configuration id="cfg1">
    <!-- More configuration data here... -->
    <Access>
        <GroupList>
            <Group>Company Name</Group>
        </GroupList>
    </Access>
    <!-- More configuration data here... -->
</Configuration>

public interface HandlerCtx {
    /**
     * Returns the {@link UserData} containing relevant information
     * for the handler
     */
    UserData getUserData();

    /**
     * Adds an arbitrary {@link InputStream} to the package.
     *
     * @param in The input stream, which the data is read from
     * @return A {@link PackageEntry entry} used for defining properties
     * on the entry.
     */
    PackageEntry add(InputStream in);

    /**
     * Adds an arbitrary {@link Reader} to the package.
     *
     * @param in The reader, which the data is read from
     * @return A {@link PackageEntry entry} used for defining properties
     * on the entry.
     */
    PackageEntry add(Reader reader);

    /**
     * Adds a DOM document
     * @param doc
     * @return A {@link PackageEntry entry} used for defining properties
     * on the entry.
     */
    PackageEntry addXML(Document doc);

    /**
     * Adds an arbitrary {@link InputSource} to the package.
     *
     * @param in The input source, which the XML data is read from
     * @return A {@link PackageEntry entry} used for defining properties
     * on the entry.
     */
    PackageEntry addXML(InputSource in);

    /**
     * Adds an arbitrary {@link Source} representing XML data,
     * which is converted via the provided {@link Source xslt source}
     * to the package.
     *
     * @param in The XML source
     * @param xslt The XSLT source.
     * @return A {@link PackageEntry entry} used for defining properties
     * on the entry.
     */
    PackageEntry addTransformXML(Source in, Source xslt);


    /**
     * Adds an arbitrary {@link Source} representing XML data,
     * which is converted via the provided {@link Source xslt source}
     * to the package using the XSLT parameters from the Map.
     *
     * @param in The XML source
     * @param xslt The XSLT source.
     * @param parameters The parameter map
     * @return A {@link PackageEntry entry} used for defining properties
     * on the entry.
     */
    PackageEntry addTransformXML(Source document, Source xslt, Map parameters);

    /**
     * Adds the content of a page object as resource
     *
     * @param pageName The name of the page object to include in the package.
     * @return A {@link PackageEntry entry} used for defining properties
     * on the entry.
     */
    PackageEntry addPageContent(String pageName);

    /**
     * Adds the result of a export businessobject output
     *
     * @param typePattern The type pattern
     * @param namePattern The name pattern
     * @param revPattern The revision pattern
     * @return A {@link PackageEntry entry} used for defining properties
     * on the entry.
     */
    PackageEntry addExportBus(String typePattern,
                              String namePattern,
                              String revPattern);

    /**
     * Adds the result of a export businessobject output transformed via
     * the provided XSLT stylesheet.
     *
     * @param typePattern The type pattern
     * @param namePattern The name pattern
     * @param revPattern The revision pattern
     * @param xslt The stylesheet
     * @param parameters A map containing parameters (optional)
     * @return A {@link PackageEntry entry} used for defining properties
     * on the entry.
     */
    PackageEntry addExportBus(String typePattern,
                              String namePattern,
                              String revPattern,
                              Source xslt,
                              Map parameters);



    /**
     * Adds the result of a export business object output transformed
     * via the provided XSLT stylesheet.
     *
     * @param typePattern
     * @param namePattern
     * @param revPattern
     * @param files
     * @param captured
     * @param icons
     * @param history
     * @param fromRelationships
     * @param toRelationships
     * @param states
     * @param archive
     * @param xslt
     * @param parameters
     * @return A {@link PackageEntry entry} used for defining properties
     * on the entry.
     */
    PackageEntry addExportBus(String typePattern,
                              String namePattern,
                              String revPattern,
                              boolean files,
                              boolean captured,
                              boolean icons,
                              boolean history,
                              boolean fromRelationships,
                              boolean toRelationships,
                              boolean states,
                              boolean archive,
                              Source xslt,
                              Map parameters);

    /**
     * Adds the output from a JPO execution.
     *
     * @param jpo
     * @param function
     * @return A {@link PackageEntry entry} used for defining properties
     * on the entry.
     */
    PackageEntry addJPO(String jpo,
                        String function);

    /**
     * Adds the output from a JPO execution. The provided
     * argument is passed to the JPO.
     *
     * @param jpo The name of the JPO to invoke
     * @param function The name of the method to invoke.
     * @param argument An argument.
     * @return A {@link PackageEntry entry} used for defining properties
     * on the entry.
     */
    PackageEntry addJPO(String jpo,
                        String function,
                        Serializable argument);



    /**
     * Adds the output from a MQL command execution.
     *
     * @param mqlCommand The command to execute
     * @return A {@link PackageEntry entry} used for defining properties
     * on the entry.
     */
    PackageEntry addMQL(String mqlCommand);

    /**
     * Adds a file from a businessobject to the package.
     *
     * @param type The type
     * @param name The name
     * @param revision The revision
     * @param format The format
     * @param fileName The name of the file
     * @return A {@link PackageEntry entry} used for defining properties
     * on the entry.
     */
    PackageEntry addFile(String type,
                         String name,
                         String revision,
                         String format,
                         String fileName);

    /**
     * Adds a file from a businessobject to the package.
     *
     * @param objectId The id of the object
     * @param format The format
     * @param fileName The name of the file
     * @return A {@link PackageEntry entry} used for defining properties
     * on the entry.
     */
    PackageEntry addFile(String objectId,
                         String format,
                         String fileName);

    /**
     * Adds the output from a structure expansion
     *
     * @param rootObjectId The id of the object to expand
     * @param roleName The name of the role, which the filters are stored on.
     * @param filterNames The names of the filters to use.
     * @param expandLevels The number of levels to expand
     * @param tableName The name of the table to apply on the result
     * @return A {@link TableExportEntry}
     */
    TableExportEntry addExpandedData(String rootObjectId,
                                     String roleName,
                                     String[] filterNames,
                                     int expandLevels,
                                     String tableName);


    /**
     * Adds the objects returned by the specified inquiry, evaluated with
     * the specified table.
     *
     * @param inquiryName The name of the inquiry to invoke
     * @param args The inquiry arguments
     * @param tableName The name of the table to apply on the result
     * @return A {@link TableExportEntry}
     */
    TableExportEntry addTableData(String inquiryName,
                                  Map args,
                                  String tableName);

    /**
     * Adds the objects returned by the specified JPO, evaluated with
     * the specified table.
     *
     * @param jpoName The name of the JPO to invoke
     * @param function The name of the function to invoke.
     * @param args The JPO arguments
     * @param tableName The name of the table to apply on the result
     * @return A {@link TableExportEntry}
     */
    TableExportEntry addTableData(String jpoName,
                                  String function,
                                  Map args,
                                  String tableName);
    /**
     * Adds the objects returned by the query arguments, evaluated with
     * the specified table.
     *
     * @param typePattern The type pattern
     * @param namePattern The name pattern
     * @param revPattern The revision pattern
     * @param ownerPattern The owner pattern
     * @param vaultPattern The vault pattern
     * @param whereClause The where clause
     * @param limit The query limit
     * @param expandType True if to include sub types to the specified type pattern
     * @param tableName The name of the table to apply on the result
     * @return A {@link TableExportEntry}
     */
    TableExportEntry addTableData(String typePattern,
                                  String namePattern,
                                  String revPattern,
                                  String ownerPattern,
                                  String vaultPattern,
                                  String whereClause,
                                  int limit,
                                  boolean expandType,
                                  String tableName);

    /**
     * Adds a custom table bean to the package.
     *
     * @param table The tablebean to add.
     * @return A {@link TableExportEntry}
     */
    TableExportEntry addTable(TableBean table);


    /**
     * Adds a {@link FileDependency file dependency}
     *
     * @param type
     * @param name
     * @param revision
     * @param format
     * @param fileName
     * @return
     */
    PackageDependency addFileDependency(String type,
                                        String name,
                                        String revision,
                                        String format,
                                        String fileName);
    /**
     * Adds a {@link FileDependency file dependency}
     *
     * @param objectId The id of the object
     * @param format The format
     * @param fileName The name of the file
     * @return A {@link PackageDependency}
     */
    PackageDependency addFileDependency(String objectId,
                                        String format,
                                        String fileName);

    /**
     * Removes a previously added dependency.
     *
     * @param dep
     * @return True if the dependency was removed
     */
    boolean removeDependency(PackageDependency dep);
}

    /**
     * Defines the name of the file, which the content is stored in.
     */
    void setSaveAs(String name);

    /**
     * Defines the directory, where the file is stored.
     */
    void setSaveIn(String dir);

    /**
     * Defines if the file should be opened once the package is created.
     * NOTE: Only one file might be opened after the package has been created
     */
    void setOpen();

/**
 * Defines if the output should be XML
 */
void setXMLOutput();

/**
 * Defines if the output should be
 */
void setCSVOutput();

/**
 * Returns true if the dependency is valid. I.e. if the file
 * really can be downloaded. This can be used to perform some
 * logic, when the file for some reason is unreachable.
 */
boolean isValid();

/**
 * Set to true if the dependency is a ZIP archive, and if
 * it is supposed to be automatically un-compressed.
 */
void setExtractIfZIP(boolean b);

<Handler>
    <MQL execForEach="true" saveAs="mql.txt">
        expand bus $\{OBJECTID} from recurse to 1 select bus id type name dump |
    </MQL>
</Handler>

<Handler>
    <URL saveIn="images"
         saveAs="technia-logo.gif">http://www.technia.com/images/logo.gif</URL>
    <URL saveIn="images"
         saveAs="Part.gif">/common/images/type_Part.gif</URL>
</Handler>

<Handler>
    <JPO program="MyJPO" method="createXML" saveAs="data.xml">
        <Arg name="first-arg" value="value of arg 1"/>
        <Arg name="second-arg" value="value of arg 2"/>
    </JPO>
</Handler>

<Handler>
    <File open="true">
        <Type>Document Template</Type>
        <Name>-0001</Name>
        <Revision>A</Revision>
        <FileName>Template.xls</FileName>
        <Format>generic</Format>
    </File>
</Handler>

<Handler>
    <TableData format="csv"
               table="My Table"
               inquiry="My Inquiry"
               saveAs="table1.xml"/>
</Handler>

<Handler>
    <TableData format="xml"
               table="My Table"
               jpo="MyJPO"
               method="myMethod"
               saveAs="table2.xml"/>
</Handler>

<Handler>
    <TableData format="csv" table="My Table" ... saveAs="table1.xml">
        <Arg name="arg1" value="value1"/>
        <Arg name="arg2" value="value2"/>
    </TableData>
</Handler>

<Handler>
    <StructureData format="xml"
        table="My Table"
        filters="EBOM From,Specifications"
        role="Global User"
        expandTo="1"
        saveAs="structure.xml"/>
</Handler>

set context user creator pass xxx;
set workspace user "Global User";
add filter "EBOM From" appliesto relationship from type EBOM;
add filter "Specifications" appliesto relationship from type "Part Specification";