Allows you to manage the folders and files in the repository.
When a folder is selected, the following actions are available:
Enables you to choose a file from the designated location and upload it to the current folder.
Alternatively, you can upload any type of file using the curl command as follows:
curl --user <username>:<password> --upload-file <source-file-path> <target-file-path>
The following shows an example of uploading a sample JAR file to /Public/lib
:
curl --user admin:sa --upload-file ~/JDBC/myfile.jar http://knockshinnie:8080/elx/do/eno/dc/content/Public/myfile.jar
You can specify the actions that users can perform on the folder.
The Access Control option for the folder is shown in Figure 2.6, “Access Control for a Folder”.
The two permissions are:
To add access rights for a user:
Reader
access when added. To grant Writer
access, select the Writer
option.
This is show in Figure 2.7, “Grant a User Access to a Folder”.
Notice that in this screen shot, although we are in the Reports
folder under User > admin > Sales
, the access rights are cloned from User > admin
folder (highest level parent folder).
admin
user will be inherited.If you are using an HTML5 compliant browser, Drop files here will appear in a text field. Drag and drop a file into the text field to upload.
The following actions are available to all file types. There are some other actions that are specific to reports and datasources, and are mentioned in their relevant sections.
This action opens the current file in a new tab. The supported file types include datasources, image files, PDF and more.
Parameters in datasources are supported, including two new types, #timestamp and #time.
Watch provides a quick way to keep track of files that are frequently used, which saves you from the trouble of repeatedly navigating to these files or searching for them.
After selecting a file, enable Watch by clicking the star () in the top right hand corner of the File Information panel. After clicking, the file will be watched, and a tag <user>#watch will be added.
Open the Overview panel and click the Refresh icon next to the watched files, and the file list will be updated.
After opening a datasource in the Ambience Web Console, you can generate it by clicking Generate. Data fields will be shown in the browser.
After opening a report in the Ambience Web Console, you can render the report by selecting from the Target drop-down list and the Render Type drop-down list. Target options include browser, mail, printer and userhome. Render type options include HTML and Simple HTML.
As an alternative to using the Ambience Web Console, you can also use HTTP requests to render a report. HTTP Requests support all the output types provided in the Render Wizard. You can send a HTTP request with a parameter list with ?mode=render and other options, or send a HTTP request with an XML body describing the options. In all cases, it is assumed that authentication has been completed as a cookie is required to be sent with each request. All requests must use POST and not GET. For a complete list of parameters used in HTTP requests, refer to Table 2.1, “Parameters”.
You can specify the parameters as part of the URL, such as “?elx.start.timeout=30&elx.end.timeout=120”, which works for all jobs. An example is as follows:
curl -X POST -u admin:sa --data "mime-type=application/x-glint &elx.target=output1&elx.start.timeout=30&elx.end.timetout=120 &elx.job.retry=5" http://MachineName:8080/elx/do/eno/re/ElixirSamples/Feature/Report/ Form.rml?mode=render
The order of parameters is not important. Report parameters are distinguished from target parameters by not having the elx.target. prefix.
The response from the parameter string version is the same as the XML version, with the same headers.
Table 2.1. Parameters
Parameter | Description | Value Options | Necessary |
---|---|---|---|
mode=render | Indicates that the report will be rendered. | render | Yes |
mime-type={mime-type} | Defines the report output type. | Refer to Table 2.2, “Mime Types” | Yes |
{name}={value} | User-defined report parameter. | Add any value. | Optional |
elx.target={target} | Defines the report output target. | Add any target. | Yes |
elx.target.{name}={value} | Defines the report output target name. | Add any value by prefixing the parameter name with elx.target. | Optional |
elx.start.timeout | Timeout parameter for job engines, which specifies the time spent in the job queue. If the job is in the queue for a time longer than this value, and no job engine starts processing it, then the job will quit. | The default value is 60 (seconds). | Optional |
elx.end.timeout | This is a timeout parameter for job engines, which specifies the time spent running the job. If a job takes longer than this value, then the system aborts the job, and assumes it was stuck in an endless loop or is thrashing. This ensures the job engine will be able to run other jobs. | The default value is 60 (seconds). | Optional |
elx.job.retry | This is a timeout parameter for job engines, which specifies the number of retries before a job gives up. This only applies for elx.end.timeout. If the job does not complete in 60 seconds, it will be put back on the queue to get picked up. Therefore, if a machine fails while running a job, the job will still have another chance at running. | In most cases, the default value is 3. | Optional |
Table 2.2. Mime Types
Name | Extension | Mime Type |
---|---|---|
Windows Bitmap | bmp | image/bmp |
Zipped Windows Bitmap File | bmp.zip | application/x-bmp-zip |
Cascading Stylesheets | css | text/css |
Comma Separated Values | csv | text/csv |
Elixir Ad-hoc Cube | cube | text/x-adhoc-cube |
Elixir Ad-hoc Dashboard | dashboard | text/x-adhoc-dashboard |
Elixir Database Filesystem | dbf | application/x-dbf |
Microsoft Office Open XML Format Document | docx | application/vnd.openxmlformats-officedocument.wordprocessingml.document |
Elixir DataSource | ds | text/x-datasource |
Graphical Interchange Format File | gif | image/gif |
Elixir Glint File | glint | application/x-glint |
HyperText Markup Language File | html | text/html |
Zipped HyperText Markup Language File | html.zip | application/x-html-zip |
Elixir Interactive Markup Language File | iml | application/x-rml-interactive |
Elixir Job File | job | text/x-job |
Joint Photographic Experts Group File | jpg | image/jpeg |
Zipped Joint Photographic Experts Group File | jpg.zip | application/x-jpeg-zip |
JavaScript File | js | application/javascript |
JavaScript Object Notation File | json | application/json |
Elixir Line Print Text File | lpt | text/x-lpt |
Elixir Map File | map | text/x-map |
OpenDocument Presentation File | odp | application/vnd.oasis.opendocument.presentation |
OpenDocument Spreadsheet File | ods | application/vnd.oasis.opendocument.spreadsheet |
OpenDocument Text Document | odt | application/vnd.oasis.opendocument.text |
Printer Command Language Document | pcl | application/vnd.hp-pcl |
Portable Document Format File | application/pdf | |
Elixir Perspective Markup Language File | pml | text/x-perspective |
Portable Network Graphic File | png | image/png |
Zipped Portable Network Graphic File | png.zip | application/x-png-zip |
Elixir Connection Pool | pool | text/x-connection-pool |
Elixir Connection Pool | pool | text/x-connection-pool |
Microsoft PowerPoint Presentation | ppt | application/vnd.ms-powerpoint |
Microsoft PowerPoint Open XML Presentation | pptx | application/vnd.openxmlformats-officedocument.presentationml.presentation |
Elixir Print | Print the file on the specified printer. | application/x-print |
Adobe PostScript File | ps | application/postscript |
Elixir Ad-hoc Report | report | text/x-adhoc-report |
Elixir Report Markup Language File | rml | text/x-report-template |
Rich Text Format File | rtf | application/rtf |
Elixir Safe File | safe | application/x-safe |
Elixir Shape File | shp | application/x-esri-shapefile |
Scalable Vector Graphics File | svg | image/svg+xml |
Zipped Scalable Vector Graphic File | svg.zip | application/x-svg-zip |
Elixir Shockwave Flash File | swf | application/x-shockwave-flash |
Tagged Image File Format | tiff | image/tiff |
Zipped Tagged Image File Format File | tiff.zip | application/x-tiff-zip |
Plain Text File | txt | text/plain |
Wireless Bitmap File | wbmp | image/vnd.wap.wbmp |
Zipped Wireless Bitmap File | wbmp.zip | application/x-wbmp-zip |
Extensible Hypertext Markup Language File | xhtml | application/xhtml+xml |
Zipped Extensible Hypertext Markup Language File | xhtml.zip | application/x-xhtml-zip |
Extensible Markup Language File | xml | text/xml |
Microsoft Excel Spreadsheet File | xls | application/vnd.ms-excel |
Microsoft Excel Open XML Spreadsheet File | xlsx | application/vnd.openxmlformats-officedocument.spreadsheetml.sheet |
Zipped File | zip | application/zip |
Run a job by navigating to the job file in the Repository and clicking Run. A new tab will open and display a message “Request Submitted”. The system will prompt for parameters (if any), run the job and display the job log when finished.
Some events may open the log viewer. For example, when you are rendering a report to mail, printer, userhome or any other target except the browser, there will be a log file link which appears in the status box at the end of the rendering. Click the log file to view the details. Alternatively, Logs are available in the /User/{User_Name}/logs/ directory in the Repository. Logs are stored in JSON files, which are excluded from indexing and are therefore not searchable. Select a JSON file and click the Open button.
The log viewer will show the appropriate actions on the right hand side. The actions include Open, View and Follow, allowing you to look at job results, view more details of exceptions or follow hand overs to other jobs.
For example, the Follow action helps you navigate through a potential tree of logs produced by multiple engines working together to solve a problem. The parent log will show the status and elapsed time of each child processing log, saving you from the trouble of following irrelevant logs.
This option is applicable when you click a datasource or a report file from the repository. It allows you to create job schedules that determine when the datasource or a report is to be run.
For more info, see the section called “Schedule”
Allows you to restore any of the previous versions of the file.
Allows you to set access rights for the file. For more information refer to the section called “Access Control”.