Difference between revisions of "OS4X internet job sharing"
Jump to navigation
Jump to search
| Line 20: | Line 20: | ||
*Mail subject (german & english): The mail subject. | *Mail subject (german & english): The mail subject. | ||
*Error page: A valid HTML body code which will be displayed to a user who tries to access the service without proper link or with an invalid password. | *Error page: A valid HTML body code which will be displayed to a user who tries to access the service without proper link or with an invalid password. | ||
| + | |||
| + | == Mail templating == | ||
| + | For the above mentioned "Mail template file" (available in german and english), the content of the file will be interpreted and variables will be substituted with actual values. The following variables are available: | ||
| + | *<code>#firstName#</code>: The given name of the user initiating the sharing process. | ||
| + | *<code>#lastName#</code>: The family name of the user initiating the sharing process. | ||
| + | *<code>#desc#</code>: A string combining last name and given name, separated by a comma and a space character (i.e. "Koch, Harald") | ||
| + | *<code>#telephone#</code>: The telephone number of the user initiating the sharing process. | ||
| + | *<code>#fax#</code>: The facsimile number of the user initiating the sharing process. | ||
| + | *<code>#email#</code>: The email address of the user initiating the sharing process. | ||
| + | *<code>#country#</code>: The country name of the user initiating the sharing process. | ||
| + | *<code>#department#</code>: The department name of the user initiating the sharing process. | ||
| + | *<code>#location#</code>: The location name of the user initiating the sharing process. | ||
| + | *<code>#company#</code>: The company name of the user initiating the sharing process: if a longname is configured, the longname will be used, otherwise the shortname will be used. | ||
Revision as of 08:38, 19 March 2015
OS4X Enterprise offers a functionality to share OS4X jobs via a simple "share" function. With this function enabled, an OS4X Webaccess user may share an OS4X job via email to a given destination for a given timeframe, optionally secured with a password.
Requirements
For this feature, you need:
- OS4X Enterprise license
- OS4X Release 2015-03-19 or newer installed
- properly configured mail transfer agent for mailing purposes (for OS4Xvirtual users, see the documentation OS4X VMware virtualized image - mail configuration)
- PHP 5.3.7 or up for security options
Configuration
In order to enable the feature, navigate in the administrative web interface to "Configuration" -> "OS4X Enterprise" -> "Webaccess":
By default, the option is disabled. The configuration options have the following meanings:
- External OS4Xapi URL: OS4X Webaccess offers a secured OS4Xapi implementation, which needs to be available to external communication partners. Many customers offer OS4X Webaccess to external partners, these may offer the subdirectorion.
- Mail sender address: With this optional setting, you can define the SMTP "From:" field in the sent mail.
- Mail templates (german & english): Absolute path to a file containing the text for the sent mail. See below for usable variables in this mail text.
- Send as HTML: the generated mail will be sent as HTML email.
- Mail subject (german & english): The mail subject.
- Error page: A valid HTML body code which will be displayed to a user who tries to access the service without proper link or with an invalid password.
Mail templating
For the above mentioned "Mail template file" (available in german and english), the content of the file will be interpreted and variables will be substituted with actual values. The following variables are available:
#firstName#: The given name of the user initiating the sharing process.#lastName#: The family name of the user initiating the sharing process.#desc#: A string combining last name and given name, separated by a comma and a space character (i.e. "Koch, Harald")#telephone#: The telephone number of the user initiating the sharing process.#fax#: The facsimile number of the user initiating the sharing process.#email#: The email address of the user initiating the sharing process.#country#: The country name of the user initiating the sharing process.#department#: The department name of the user initiating the sharing process.#location#: The location name of the user initiating the sharing process.#company#: The company name of the user initiating the sharing process: if a longname is configured, the longname will be used, otherwise the shortname will be used.