My Stuff and it's Object action Tools<br/>This is a short introduction to the Object action box that is displayed when a member enters their My stuff area. I also describe the main content area of a members workspace. For more specific information, check the Nuxeo CPS websites listed below, or the text files that were installed with CPS. CPS v3.14 was used to create this document. Nuxeo CPS Websites Nuxeo.com ­ http://www.nuxeo.com - this is a French website. If you don't read French, skip this one. CPS-Project.org http://www.cps-project.org Nuxeo.org http://www.nuxeo.org Nuxeo at Zope.org http://zope.org/Members/nuxeo/Products My Stuff and it's Object action Tools........................................................................ 2 Screen Section ­ The Centre ................................................................................. 3 Screen Section ­ The Right Side........................................................................... 5 Object actions ­ View &amp; Folder contents .......................................................... 5 Object actions ­ New ......................................................................................... 6 Object actions ­ Edit .......................................................................................... 7 Object actions ­ Metadata .................................................................................. 8 Object actions ­ Local roles ............................................................................... 9 Changing Local roles ....................................................................................... 10 Boxes Management .......................................................................................... 11 Adding a new box ........................................................................................ 12 I am not an expert with CPS, but most of the information in this document should be reasonably accurate. If you find anything that is wrong, send me an e-mail and I will try to update the documents. Other documents will be added to this series as I get the time to create them. Author Steve Meaker stevem@manitacc.com Aug 17 2004<br/><br/><br/>My Stuff and it's Object action Tools<br/>The My Stuff area of the site is really a workspace. The only difference between this and other workspaces is that the member who `owns' the workspace has full control of the contents and the visibility of the contents, while in a `normal' workspace full control is restricted to the site manager or assigned workspace managers. A member can create content and share this content with other members of the site. When a member picks on the My Stuff option, the screen will change to display the contents of their personal workspace. If this is he first time you have entered your workspace you should see something similar to Figure 1.<br/><br/>Figure 1. The default 'My syuff' contents for a new member.<br/><br/>The screen shot shown in Figure 1 contains only one item, the Calendar of stevemem. In this document the login name of the user is stevemem! This screen contains several areas that need explanations.<br/><br/><br/>Screen Section ­ The Centre<br/>The centre section of the screen (I am from Australia, we spell centre like this!) contains the contents of the members personal area (or whatever workspace is currently being viewed). In this case, as shown in Figure 2 there is only one item showing; the Calendar of stevemem. In the default installation of this version of CPS the members personal Calendar is the only item that is visible the first time the My stuff workspace is entered.<br/><br/>Figure 2. The central section of the members workspace<br/><br/>The default view displays the workspace using the Folder contents view, which is one of the options available for selection from the Object actions box on the right side of the screen. There are also several buttons that allow you to manipulate the contents of this area. The group of buttons below the Calendar of stevemem become very useful once this workspace contains several items. · The Select all button is only useful if there are multiple items in the workspace. · You can Cut and Copy content items between your personal workspace and any other workspaces you have the rights to create content in. · The 4 Move buttons allow you to manipulate the order of the contents in the workspace. It is obvious what each button does. · The meaning of the Delete button should be obvious! You must select the item or items to be deleted first. When you select the Delete button you will then be presented with a confirmation box where you have to answer Ok to the question &quot;Are you sure?&quot; · The button labelled Change object id requires some explanation. Every content item you create is given a unique object id. The object id is used to create a unique web address to this content item. Normally you don't need to worry too much about the object id, as CPS creates the object id by using the name you supply for the content you create. The object id is not always going to be the same as the name of the content you create. CPS creates the object id as a character string of up-to 20 characters. If this 20 character long object id is not unique, CPS will then add a 4 digit random number to it to make sure it is unique. The name you enter for the content you create is used as the base name. Any spaces you enter are replaced by under-score ( _ ) characters. Also, any upper-case characters you entered will be changed to lower case. Unless you want a particular object id for the content you are creating, you can ignore this button.<br/><br/><br/>The other options available for selection in Figure 2 control the display of the content within the workspace. There are 2 drop down lists that allow you to filter the contents of the current workspace so only content that matches the sort criteria is shown. Other content is hidden until the sort filter is re-set. Figure 3 shows the different options available in the Sort by drop-down list.<br/><br/>Figure 3 - Showing the sort by options.<br/><br/>Figure 4 shows the different way you can display content items within the current workspace. Experiment and see the affect of the different sort and display options. You will need to create several different content items before the Sort by and Display options are of much use. \<br/><br/>Figure 4 - The display option available<br/><br/>After setting the Sort by and Display options you need to pick on the Apply button to apply your settings to the current workspace.<br/><br/><br/>Screen Section ­ The Right Side<br/>The right side of the screen contains a box labeled Object actions, and another labeled Folder actions (Figure 5). These boxes contains several commands that are essential, and some commands that are not used as often. It is possible that some items shown here may not be available if the site manager has decided to remove them.<br/>Figure 5 - Object and Folder action boxes from the right side of the screen.<br/><br/>Starting from the top of the Object actions box, each option will be explained below.<br/><br/>Object actions ­ View &amp; Folder contents<br/>The View option, not surprisingly will change the view of the current workspace. In this case, when we first entered the My stuff area we were presented with the Folder contents view of the workspace contents (Figure 2). Figure 6 shows the same workspace contents after selecting the View option.<br/><br/>Figure 6 - The workspace contents after selecting the View option<br/><br/>Notice how you can now only see the Calendar of stevemem. There are no options available for selection at all in the centre portion of the screen, except the content item, Calendar for stevemem. If you want to get back to the previous view where you can manipulate the display, change contents order or delete content just pick on the Folder contents option on the right side of the screen.<br/><br/><br/>Object actions ­ New<br/>The New option is used when a member wants to create new content. Selecting New changes the screen to show the available content types that the member can create (Figure 7).<br/>Figure 7 - The Add contents screen shown after picking the New option.<br/><br/>Each of the items shown in Figure 7 is explained in separate documents. Where necessary several items will be combined into a single document, as some content types are, while not dependant on others, only really make sense if they are used together. For example, a FAQ Item makes more sense and is easier to explain when it is used inside a set of FAQ (Frequently Asked Questions). Hence these items are combined into a single document. The content items displayed here include one item not available in the default installation of CPS. The CPSZWiki item is an add-on product and is not installed by default. There are many different content types displayed on this page.<br/><br/><br/>Object actions ­ Edit<br/>The Edit option from the Object actions box allows you to edit the name and description of the current workspace. When you select Edit the screen below (Figure 8) will appear. The only item that requires some explanation in Figure 8 is the Hide this folder in the navigation option. Here you can select either Yes or No from the drop down list. If you select Yes and elect to hide the folder (or workspace in this case) you may not notice any difference because it is the My stuff folder. If you elect to hide another workspace you have created within your My stuff area, you will only be able to see the folder while looking at the Folder contents view of the parent folder. The hidden workspace will not appear if you select the View option to see you're My stuff area. Hidden folders also do not appear in the site Navigation box that normally displays your current location within the site. (The site Navigation box will be described further on in this document. It is on the left side of the screen shown in Figure 1). After changing the workspace title and description, pick on the Save Changes button, and then pick on the View option from the Object action box on the right side of the screen. Figure 9 shows the results of editing the workspace name and description.<br/>Figure 8 - Editing the My stuff properties.<br/><br/>The words Steves Workspace is the new title. The description shown above has been entered with some extra carriage returns. Notice (Figure 10) how the layout of the description is modified from how it was entered. The yellow box shown in Figure 10 containing text will appear when you pick on the yellow question mark ( ? ) button. This is a popup help screen. You will see similar buttons on some CPS screens. If you pick on these buttons you should see a popup containing some explanatory text. Also notice how the description text displays in Figures 8 &amp; 9. You can't change the description layout. White space is removed automatically.<br/>Figure 9 - The results of editing the workspace properties.<br/><br/>Compare how the title is displayed in Figure 4. There is still only one content item in this workspace, the Calendar of stevemem.<br/><br/><br/>Object actions ­ Metadata<br/>The Metadata option has many different fields available for you to change if necessary.<br/><br/>Figure 30 - workplace metadata<br/><br/>All fields and data in the Metadata section are available to the site search engine when it is searching the site. If you want your content to be fond easily in searches, use metadata fields to add extra &quot;keywords&quot; that will help identify the content. You can change the title and description from this page. The Subject, Rights, Source, Coverage and Relation fields can have entries added. The Effective and Expiration dates determine when the content is available to or expires from publication. Extra contributors can be added if the workspace is shared. The help messages from the popup help buttons ( ? ) are all displayed in this image. In reality these will only appear when you pick the buttons.<br/><br/><br/>Object actions ­ Local roles<br/>Local roles are the method by which other site members and anonymous users are given authorization to access content. The Local roles option is only available to the manager of a workspace. If you do not have the authority to change Local roles you will not see this option. In the case of a members My stuff area, the member is also assigned the workspace manager role in their own workspace, and can assign access to any of the content within to any other site members. A site member can change the access permissions to their complete workspace (My stuff), or as is more likely, to a workspace or some other content item that they have created within their My stuff area. WARNING Be careful when assigning Local roles to other site members. Make sure you do not give too much access to members who do not need it. If you change the Local roles of a workspace, ALL CONTENT within and below the workspace is also changed. When you pick on the Local roles option the following (Figure 11) is shown in the central part of the screen.<br/><br/>Figure 11 - The Local roles assignment facility.<br/><br/>The Local roles can be set in the top half of the screen. The lower part of the screen In Figure 11 shows the Currently assigned local roles. In this case, the only role that is set on the workspace is the Workspace manager role that is assigned to stevemem. The reason stevemem (a site member, not a manager) is listed as being the Workspace manager is because the workspace was created in stevemems' personal workspace.<br/><br/><br/>Changing Local roles<br/>In order to change the Local roles for the content selected (the workspace in this case) you must find and apply two pieces of information. 1. The member or group to assign the new role to. 2. The role to assign the new user(s) This is done by searching for the user or group and then selecting the role to apply. There are three methods of searching (see Figure 13); by User name, Group name or by the User email address.<br/><br/>Figure 12 ­ A search result after searching for groups. The search term was blank.<br/><br/>Figure 12 shows the result of a search for Groups. To change roles you select the check box next to the preferred Group (or Groups). Then select the role to assign from the drop down list shown expanded in Figure 12. Of the Groups shown in Figure 12, only the role:Anonymous and role:Authenticated are default groups. The SiteAssociate, SiteMember and SiteManager groups were all created by me. If changing roles for an individual, search on the User full name or User email address. The User full name actually searches on the User login name field, not the First name plus Last name. You do not need to type the full name of the member you are searching for, and the search term you use is not case sensitive. For example, to find the name Steve a search term of StE, steve, STEV or st will all find the correct name. The same search using the User email address would return all members with an email address starting with st. The asterisk ( * ) wildcard can be used for searching if you do not know the name of the member you are searching for. Using the asterisk wildcard will display all members, all groups or all email addresses for all site members with an email address set in their preferences. If the asterisk ( * ) search does not work, try searching with a blank search term I have found that some CPS search areas work with an asterisk, others with nothing at all in the search term. The CPS security model uses the roles assigned to the content you (or others) create as the &quot;measure of access&quot;. If you (the member logged in) have been assigned a role in a workspace, the same role is automatically applied to all contents of the workspace. Acquisition is the method used to apply roles to new objects that are created. As you are the only person with roles assigned in your private area (the workspace manager in this case), role acquisition allows you to have the same role in any workspaces you create in your private area.<br/><br/><br/>Boxes Management<br/>The Boxes Management option may not be available to all users. Many sites turn this option off. Boxes Management allows you to alter the display dramatically. The CPS screen layout is defined with Slots and Boxes. The My stuff screen is made from 5 slots and 15 boxes. Using the Manage boxes option you can add, edit or remove boxes to the screen layout. If you can see the Boxes Management option, pick on it. You will see a screen similar to Figure 19.<br/><br/>Figure 13 - The Manage boxes screen<br/><br/>The screen shot in Figure 13 has been edited by dividing it into 5 different areas with heavy lines. These 5 areas represent the different `Slots', or box containers. Each slot is numbered and has an arrow pointing to its' definition. Each slot consists of 0 or more boxes, with each box containing content. The display order of the boxes is determined by the Order field (see at tip of arrow 5 in Figure 13). The lower the order, the higher the box will appear in the slot. For example, the Left slot in Figure 13 contains 4 boxes.<br/><br/><br/>Base box ­ Order 10 This box is labelled Locale selector. This is the language selection drop down list. · Action box ­ Order 20 This action box, labelled User actions is the box with the users name above it (Steve Member in this case) · Action Box ­ Order 30 This Portal actions box is labelled as such. For a member it normally only displays Directories. · Tree box ­ Order 40 This Tree box is labelled Navigation and shows the current users permitted workspaces. The box numbers do not have to start at 10 with increments of 10. You could start at 1 and increment by 1 if you want. The advantage of starting at 10 and incrementing by 10 is that you can easily add other boxes in between existing boxes, using 5, then 7 etc. Starting at 1 and incrementing by 1 allows for no flexibility in adding boxes later, you would have to re-number some boxes to get the right order.<br/><br/>·<br/><br/>Adding a new box<br/>In this example we will insert a new box on the right side of the My stuff area. We will make this box visible in the My stuff area and any workspaces created below this. Note ­ as a member, the only place I can modify the Boxes layout is in my own personal workspace or in other workspaces where I have been given the workspace manager role. First, I need to make sure I am in the correct location. Just picking on the My stuff option will take me there. Once I am in the correct location I then pick on the Boxes Management tool. This will display Figure 13. Near the top right corner of section 3 in Figure 13, you can see the words Create box, which are circled. Picking on Create box will change the screen to show the Add a box menu, similar to Figure 14 below.<br/><br/>Figure 14 - The Add a box selection menu<br/><br/>In Figure 14 I have already selected the Event Calendar Box, and typed in a name for the new Event calendar I am creating. ( My Calendar; not very imaginative, is it?) As you can see, there are 10 different types of box that can be installed. I will leave it to you to experiment with each type. I suggest you create a Testing workspace to try out box modifications, and try adding new boxes and experiment a bit until you understand how each type works. Only when you know what you are doing should you attempt to modify your My stuff boxes layout, or any other workspaces that you manage.<br/><br/><br/>After I pick on the Add button the screen will again change to that shown in Figure 15. Here we set up how and where the new box will appear. Figure 15 shows only the Right slot and the Default skin for folders part of the screen, as the other parts do not change. The order of the items currently in the right slot (see Figure 13) show the Object actions box as 10 and the Folder actions box as 20. Before you add a new box to a slot, make sure you check the order of any items already in the slot.<br/><br/>Figure 15 - the Box created screen<br/><br/>Figure 16 below shows the options available in the Slot, Box skin and Display drop down lists. The options set in this screen are: Slot - to display in the right slot Box skin ­ The type of box. min/max/close style allows you to shut the Calendar box. Order ­ to force the new calendar to be above the other slot contents. &quot;Visible in subfolder&quot; is ticked; ­ this means that the calendar will be visible in this workspace and all workspaces created below it. In the lower part of the screen is a scrolling list where you can select &quot;Document types considered as events&quot;. You can select multiple document types by holding the Ctrl button while you select items in the list. Unless you are using a customised CPS system the only valid selection here (in a Calendar box) is Event. Select Event in the list shown. You can see the note just above the save buttons. If you disregard this note the calendar may cause an error. The only `documents' with a start and end date are Events!<br/><br/><br/>Figure 16 Drop down lists shown in Figure 15<br/><br/>Experiment with settings from Figure 16 to see what the different options do to the appearance of any box you add or edit. If you get it wrong, just come back and edit the box until you are satisfied. Once I pick on the Save Changes button shown in Figure 15, the right slot changes. The new Calendar box is shown (see Figure 17).<br/>Figure 17 - The Right slot with the new Calendar box added.<br/><br/>There are many combinations of options for boxes layout (hundreds, if not thousands).<br/><br/>That concludes this explanation of the My Stuff area for a site member. You should be able to use most of the site tools without too much trouble.