PSD1131 – PDF/Excel export from IM form

Fact

• PhenixID Identity Manager IM 5.3.1 or later
• In IM 5.4.3 improved functionalities was added to support export of multi-value attributed.

Situation

Export information from an IM form to an PDF- or Excel file. Either several attributes on one object or one attribute that holds several values (multi-value).

Solution

Export several attributes from an edited object

Use case – You like to export one or several attributes on an edited object.
See screenshot below:

Add a button in the form to export to PDF or Excel. (or add two buttons to export to either). See screenshot below:

Configure PDF/Excel
(see screenshot of configuration below for the screenshots above)
1. Open Tab Designer in Identity Manager Configurator
2. In the toolbar, drag the Create a PDF or Excel Export control button to the workspace. (the button looks like an PDF button)
3. In the Control Properties click Options for Custom Control
4. In Export type:, select PDF or Microsoft Excel.
NOTE: Do not check the check box for DN Attribute, that is for the next scenario
5. Title. For Excel this will be the name of tab, for PDF this will be the top header in the document. You can also add attributes to this label from the object. For example the title could look like Report of Jeff Gordon, where Report of is string data and Jeff Gordon is picked up from the object. The code for this to add in Title would look like Report of {cn}
6. Click Add (you can add any attribute on the object that is currently being edited, not only the attributes in the form)
6.1 Below is settings explained for when you have clicked Add
Attribute: – Choose the attribute you like to add to your export.
Label: – You could have a label for the value. If you have selected sn as attribute for example you might like another label like Last name.
Type: – Is the value single or multi value?
Syntax: – What type is the value. For example will date be translated in something that is easier to understand.

Example of screenshot below of screenshots above:

Add another button to the same form
Let say that you already have added a button for PDF and now also like to add a button for Excel. Just do as explained above but change the Attribute name: in the Control Properties. By default it is PDFExcelExportFunction, change name to PDFExcelExportFunction1 or whatever you like that is not taken in the form.

Export one multi-value attribute from edited object

Use case – You like to export one multi-value attribute from one object. For example all groups the user belongs to. You also like to include information of each group like description in the export. See screenshot below:

Add a button in the form to export to PDF or Excel. (or add two buttons to export to either). See screenshot below:

Configure PDF/Excel
(see screenshot of configuration below for screenshot above)
1. Open Tab Designer in Identity Manager Configurator
2. In the toolbar, drag the Create a PDF or Excel Export control button to the workspace. (the button looks like an PDF button)
3. In the Control Properties click Options for Custom Control
4. In Export type:, select PDF or Microsoft Excel.
5. Check the checkbox of DN Attribute and add the multi-value attribute you like to add all values of
NOTE: Do not check the check box for DN Attribute, that is for the next scenario
6. Title. For Excel this will be the name of tab, for PDF this will be the top header in the document. You can also add attributes to this label from the object. For example the title could look like Report of Jeff Gordon, where Report of is string data and Jeff Gordon is picked up from the object. The code for this to add in Title would look like Report of {cn}
7. Click Add (you can add attributes of the listed object from the multi-value attribute.)
7.1 Below is settings explained for when you have clicked Add
Attribute: – Choose the attribute you like to add to your export.
Label: – You could have a label for the value. If you have selected description as attribute for example you might like another label like Group description.
Type: – Is the value single or multi value?
Syntax: – What type is the value. For example will date be translated in something that is easier to understand.

Example of screenshot below of screenshots above:

Export when multi-edit

If you like to export several users from a result set, let say you select 10 user and like to export all 10 users group membership, this is also supported. Make sure your form has multi-edit enabled. For Excel this will be one Excel tab per object, for PDF this will be one document per object.

Example of screenshot of three user: