Core Content Only

Changing the From Address

If you want to change the from address on a workflow email notification the following line of code will allow you to change it. You must set emailFromAddress before you use wfNotify. For example, in the entry event for a workflow, you can use this code to change the from address on email notifications.

<$emailFromAddresss=”records_management@mydomain.com”$>

Custom Email Notifications

Ever needed to notify a user that a docoument has been released and is ready for viewing? The following code can be used to do just that. It can also be easily adapted for other situations.

For example, in the exit event of your workflow step, use the following custom Idoc Script code:

<$wfMailSubject=”File <$dDocName$> has been released”$>

<$wfNotify(dDocAuthor, “user”, “WORKFLOW_RELEASED_NOTIFICATION”)$>

The first line of Idoc Script uses the wfMailSubject variable.

From the Idoc Script Reference guide:

wfMailSubject defines the subject line of a workflow e-mail notification.If no subject line is specified, the e-mail will use the default subject for the type of notification (review, reject, or workflow started). Idoc Script can be included in the subject string.

The second line of Idoc Script uses the wfNotify workflow function:

wfNotify sends an e-mail message to a specified user, alias, or workflow token.

wfNotify takes two parameters and an optional third parameter:

■ The first parameter specifies the user name, alias, or token to be notified.

■ The second parameter indicates the type, either user, alias or token.

■ The optional third parameter specifies the name of the e-mail template to use for constructing the message. (See theIdcHomeDir/resources/core/templates/templates.hda file for template definitions.)

As you can see above, I have used a custom Workflow template which I created and bundled with my component. You can download the sample template here.

Below is a picture of what an email looks like using this sample template.

Disabling Workflow Review Email Notifications

If you or your RMA admin decide not to receive email notifications when an item is ready to be reviewed, the following code will suppress this email notification. In the entry event of a workflow put the following Idoc Script:

<$wfSet(“wfJumpEntryNotifyOff”, “1″)$>

Recently a forum post came up asking how to include files along with a custom component. This is a fairly simple process.

You need not checkin the files to content server. Instead, put the files you want to include with your component here:

server/weblayout/resources/MyComponentName/

Then in Component Wizard -> Build Settings, add a “Weblayout” entry type and link to the above path.

To use your content, you can use the following Idoc Script code to include a JavaScript file:

<script type="text/JavaScript" src="<$HttpRelativeWebRoot$>resources/MyComponentName/jquery.js"></script>

And that’s it! It is that simple. Included files can be anything ranging from JavaScript (think jQuery) to images to CSS.

<component_name>:<component.zip>:<preference_data>

This next part will use symbolic links. If you wish not to use symbolic links, skip down to the Windows XP/Server 2003 or Linux section. If you are using Windows XP/Server 2003 or lower, you cannot take advantage of symbolic links. Skip down to the Windows XP/Server 2003 section. If you are using Linux you may skip to the Linux section below.

Windows Vista and higher

Since Windows Vista, Microsoft has included symbolic links in its Operating System. Those who are familiar with Linux probably already know what these are. For the rest of us, Wikipedia defines a symbolic link as a special type of file that contains a reference to another file or directory in the form of an absolute or relative path and that affects pathname resolution. Symbolic links operate transparently for most operations: programs which read or write to files named by a symbolic link will behave as if operating directly on the target file.

The benefit to using symbolics links is we can continue to build components in their own directory. We simply drop a symbolic link to the zip file in our main component and it will bundle the zip as if it were actually within our main component folder.

A very handy Windows Explorer shell extension called Link Shell Extension has been developed by Hermann Schinagl. You can download both x86 and x64 builds here. Documentation for Link Shell Extension can be viewed here.

Once you have Link Shell Extension installed, it is very simple to use. Simply right click on the target file (the component zip you want to bundle) and select pick as link source. Then navigate to your main component directory. Right click in the white space and select Drop as and select symbolic link. Make sure to use symbolic link as hardlink will not work the way we want it to.

Linux

Symbolic links can be made using a simple command.

ln -s {target-filename} {symbolic-filename}

Windows XP/Server 2003

If you are using an version of Microsoft Windows older than Vista, these do not have symbolic link support. However, you can still bundle components. You just have to be a little more meticulous how you go about it. Everytime you want to build your main component and bundle the other versions with it, you will need to first build those components, then copy the produced zip file from that directory to your main component directory. This process is more time-consuming and can be easily forgotten which is why symbolic links are recommended.

Final Steps

Now that you have a symbolic link (or a copy of the zip file) in your main component directory, you may move on to adding the bundled components to your main component.

You should now be back at the main component wizard screen. From the build menu, select Build. On this screen, click the Add button. Here, you will need to select Component Extra.

This part is slightly tricky. For Sub directory or file, enter “MainComponentFolder/BundledComponent.zip”.

It should be able to find this now that we have our symbolic link (or copy of the component) in place. If it does not find the zip, retrace your steps. Click OK to close this window.

Now you can build your component. If you need to rebuild your components, simply build your extras, then build your main component. If you are using symbolic links there is no need to copy the bundled components. Symbolic links take care of all this.