iglobe CRM SharePoint App Documentation Version Thursday, January 30, 2014 Support contact iglobe:

Transcription

1 Tuborg Boulevard 12,3 sal 2900 Hellerup, Denmark Phone: URL: iglobe CRM SharePoint App Version Thursday, January 30, 2014 Support contact iglobe:

2 Contents 1 INSTALLATION AND CONFIGURATION OF CRM SHAREPOINT APP Prerequisite Create an App Catalog site Add App in App Catalog Site Deploy IGlobe CRM App Adding users to the CRM site Deploy IGlobe CRM App from Site Configuration Upgrade App Using App Catalog IMPORT DATA From NNE Import Master Data LIBRARIES Documents Document Template Drop Off Library Picture OPERATIONS Company Contact SSO KEYWORDS LIST IN IGCRM CRM API DESCRIPTION To Get Outlook Inbox To Get Outlook Sent To Get Details To Get Outlook Calendar Event To Authenticate App User To Search Company from NNE To Update Company Information From NNE To Get Company All Information From NNE To NNE Market Data Page 2 of 49

3 To Get Company Decision MakersfFrom NNE To Sync Automatically To Sync by Click on Sync Button To Get Keyword Data from NNE (Key value pear) To Get Keyword Data from NNE (Value only) CRM SHAREPOINT APP USER DOCUMENT Browser Compatibility Change Internet Explorer Settings APPPART SETTINGS CONFIGURING THE HARMON.IE IN OUTLOOK Page 3 of 49

4 1 Installation and Configuration of iglobe CRM SharePoint App This document will help you to understand, how to install, configure and upgrade iglobe CRM SharePoint App in your SharePoint Developer site. iglobe CRM app is a SharePoint App supporting SharePoint The app support both SharePoint Server on primes and SharePoint Online. 1.1 Prerequisite 1. SharePoint 2013 app hosting environment. 2. Browser: IE10 and upper version, Chrome, Mozilla Firefox. Notice some feature requires IE and will not function using other browser. More specific the Outlook Calendar and Task integration requires IE browser. iglobe advise that the app is install and updated in SharePoint App Catalog. If you organization do not have an app catalog follow the instruction in 1.2. If your organization already have created an app Catalog please proceed to Create an App Catalog site 1. Sign in to the Office 365 admin center with your SharePoint Online admin user name and password. 2. Go to Admin > SharePoint from the top navigation bar. 3. Click Apps on the left navigation section, and then click App Catalog link. 4. Select Create a new app catalog site, and then click OK. 5. On the Create App Catalog Site Collection page, enter the required information, and then click OK. After the App Catalog site is created, you can navigate to it within the SharePoint admin center by clicking Apps >App Catalog. The App Catalog site will have a document library for Apps for Office and a document library for Apps for SharePoint, as well as a list that tracks App Requests from site users. For more information, please use the following link. Figure 1: SharePoint App Catalog Page 4 of 49

5 1.3 Add App in App Catalog Site Use the following steps to add SharePoint app in app catalog: 1. Open your SharePoint site in browser. Click on Admin dropdown menu from top right corner of the navigation bar, and then click on SharePoint from the menu items. Figure 2: SharePoint Admin Dropdown It will take you to the SharePoint Administration page like below. Page 5 of 49

6 Figure 3: SharePoint Administration Window 2. Click on apps from the left menu. It will take you to the apps settings page like below. Figure 4: Apps Settings Window 3. Click on App Catalog from the top of the page. It will take you to the following window. Page 6 of 49

7 Figure 5: Apps for SharePoint Catalog Window 4. Click on Apps for SharePoint from the left menu. It will show you a window like below. Figure 6: App List in SharePoint App Catalog 5. Now drag and drop iglobecrm.app package on the apps list as shown in the image below. Page 7 of 49

8 Figure 7: Drag and Drop App in App Catalog Wait for few minutes for the adding process to finish. This completes the adding of the app in App Catalog. For more information use the following links Deploy IGlobe CRM App Deploying an app essentially installs that app on a site for users so that it is available for use. Deployed apps appear on the Site Contents page for a site. iglobe advise that you deploy the app on a separate site collection, a iglobecrm site collection. First step is therefore to create a new site collection for iglobe CRM. Use the following instruction to create a new site collection. Create a site collection in SharePoint iglobe advise to use a Team Site template for the site collection. Page 8 of 49

9 1.1.1 Adding users to the CRM site iglobe CRM App uses SharePoint site group access and permission. Site owners have the Full Control permission level on that site. They can perform administrative tasks on the site, and on any list or library within that site. They are also grated admin access to iglobe App and have access to the administration are of the CRM app. To be able to configure iglobe App you will need to have access to the administration. Site Members are user of the CRM app that will not require access to the administration part should be added into the member group. After you have configures user access to the site you are ready to add the iglobe app to your site. With the new site collection you are ready to deploy iglobe CRM app. Page 9 of 49

10 1.5 Deploy IGlobe CRM App from Site Open your site with admin user and password where you want to install this app. 1. From you site open, go to Settings > Add an app from the top navigation bar. Figure 8: Add app from a site 2. Click on the App that you want to add from the available apps list. Figure 9: Added app list 3. Click on Trust IT from the prompt window to proceed. Page 10 of 49

11 Figure 10: App trust prompt window 4. Wait for few minutes it will install IGlobe CRM App in your site. You can get more information about app catalog by visiting the following link. Page 11 of 49

12 1.6 Configuration App Configuration After successfully completing the app installation, you have to configure the app before start working. To configure the app, do the following steps: 1. Click on the IGlobeCRM app link that you installed. It will take you at our app home page. 2. From home page, click on Admin section. It will take you to the Administration page. Figure 11: IGlobe CMR App Homepage 3. From the left menu of the Administration page, click on Configuration menu item. It will show you Configuration sub menus. Page 12 of 49

13 Figure 12: IGlobe CRM App Administration Page 4. From the configuration sub menus, click on App Config menu item. It will take you to the app config page. Figure 13: IGlobe CRM App Configuration Item List Page 13 of 49

14 5. From the App. Config page, change the items app config values with your own value. To update an item, select an item then select Items tab from the secondary topbar of the page, click on Edit Item from the ribbon button. Figure 14: Configuration Item Selection Window for Edit It will open edit item window like the image below. Figure 15: Configuration Item Edit Window Page 14 of 49

15 6. Don t change the Title and AppConfigKey, only change the AppConfigValue. Write new app config value in AppConfigValue text field. 7. Click on Save button to save your changes. [Note: Don t change the Title and AppConfigKey] 8. Update the entire configuration items by following the same instruction. Key and Value Settings for Configuration Key Name WeekSta rtday TotalWor kdays WorkSta rttime WorkEn dtime NNEAcc esskey APPURL IGServic eurl MaxRow Size Personal SiteUrl Key Value Note 0 Sunday = 0, Monday = 1, Tuesday =2, Wednesday = 3, Thursday = 4, Friday = 5, Saturday = 6. 5 How many work days in a week your office 9.00 The time your office starts. In 24 hour format The time your office closes. In 24 hour format. ***** The key to access NNE data base services. Your app url. From example [ iglobecrmappdev/iglobecrm] The url of your web services [The number of items in a single list.] Write your SharePoint personal site url. Example: Add your app name at the end of your developer site url. If your developer site url is s/iglobecrmappdev and app name is iglobecrm then app url will be s/iglobecrmappdev/iglobecrm. Please don t add app url with app ID. Write the url of your hosted web services. If you think in a single list, there will be 500 item then write 500, if you think it will be 10,000 then write 10,000. Your personal site url in SharePoint. Following is the example how you can get your personal site url. Page 15 of 49

16 How to get SharePoint personal site url 1. From the developer site click on the dropdown menu where it s showing your name. Click on about me. It will take you to your personal page. 2. Following picture will give you details idea how to get the personal site url. Figure 16: How to go personal site window 3. From the personal site page, copy the url from the browser. Only the part which is highlighted in red marking in the picture below. [Example: Figure 17: SharePoint Site Personal Page Page 16 of 49

17 Web Service Configuration You have to give user authentication information to access IGCRM app from web service. This is necessary to get the Outlook sync process to work. To configure web service configuration, the following steps: 1. Go to Admin > Configuration > Web Service Config. It will open the configuration window like below. Figure 18: Web Service Configuration Window 2. Write site user login-name in Login user name field. [User should have read, write and delete permission] 3. Write user password in Password field. Now click on Verify button to verify user authentication. Note: [This user authentication is required for auto sync, sync and other services as well.] 4. Your app configuration is almost done, but before you start working, add your application user in user list. Now your application is ready to start working. Page 17 of 49

18 1.7 Upgrade App Using App Catalog Following are the instruction to update existing IGlobe CRM App. We assume that you already have an updated version of iglobecrm.app file. 1. Login to your SharePoint site as an Admin user. Click on Admin > SharePoint from site top menu bar. Figure 19: SharePoint Admin It will show you SharePoint Administration window. 2. From the SharePoint Administration window left menu Click Apps > Apps-Catalog. It will take you to the app catalog page. Figure 20: SharePoint Administration Apps Page 18 of 49

19 3. From the left menu of the app catalog page click on Apps for SharePoint. It will show you all the apps, which are already added in this catalog. Figure 21: SharePoint App Catalog 4. From the top menu select File > Upload Document to upload the latest version of IGlobeCRM.app Figure 22: Upload Latest Version of IGlobeCRM App Window Page 19 of 49

20 5. By clicking on Upload Document, it will show you file upload window. Clicking on Browse... button show the latest version of IGlobeCRM.app package. Figure 23: Upload New Version [Note: Make sure that Add as a new version to existing files checkbox is checked.] 6. Write any version comments if you want to. 7. Click on OK button. Wait for a while to update the newest version. When upload is complete then it will show you a window like below. Page 20 of 49

21 Figure 24: SharePoint App Property Window 8. Fill up the form with related information. If you want, you can keep it default as it is. 9. Click on Save from ribbon button to save it. Wait for a while then you will see the latest version of the IGlobeCRM app package in the catalog list. Figure 25: New Version Added in Catalog Page 21 of 49

22 10. Click on the Site Contents from the left menu. It will show you all the site contents added in your site. Figure 26: Upgrade IGlobeCRM App 11. Beside IGlobeCRM you will see An update for this app is available. Click on the update link for IGlobeCRM. It will show you a window like below. Figure 27: IGlobeCRM Upgrade 12. Click on GET IT button. It will show you permission window like below. Page 22 of 49

23 Figure 28: App Permission Window 13. Click on Trust It button. It takes a bit time to update the app. So wait until the update complete. 14. When upgrading is complete, click on the app. It will take you to the app home page. Page 23 of 49

24 Figure 29: IGlobe CRM App Homepage 15. Click on the Admin section from the homepage. It will take you to Administration page. 16. From the left menu of the Administration page, click on Administration tab. Figure 30: Administration Settings To Upgrade App 17. From the Administration sub menu, click on Features. It will show you all the features that are in the site. Page 24 of 49

25 Figure 31: App Features for Administration 18. Deactivate both IGlobe CRM Master List Feature and IGlobeCRM UI Feature features by clicking on Deactivate button. If you cannot see IGlobe CRM Master List Feature and IGlobeCRM UI Feature, scroll down to see those features. Figure 32: Deactivate IGlobe CRM Features Page 25 of 49

26 19. It will show you deactivation confirmation window like the image below. Click on Deactivate this feature to deactivate the feature. Do the same thing for both features one by one. Figure 33: Deactivation Confirmation of IGlobe CRM App Feature 20. Now you have to activate those features again. First, activate IGlobe CRM Master List Feature and then Activate IGlobeCRM UI Feature. Figure 34: IGlobe CRM App Features Activation Page 26 of 49

27 21. Click on the activate button to activate both features again. Wait for a while until the feature activation is complete. Now the upgrading of the IGlobe CRM App is complete, and is ready for the users to experience the upgraded version of IGlobe CRM Application. 2 Import data Admin user can import data from NNE and from a file to a list. 1.8 From NNE The master data needed for NNE can be imported by clicking on the From NNE button, which can be found at the top of the admin page. [Note: This is a very slow process because its get data from NNE web service and then add those data in your app. So its better perform this action while your have bit more time. And don t do this operation quite often.] Figure 35: Import Master Data from NNE This will import the following data NNE a) NACE b) Branch Group c) Company Status d) Function Area e) No. of Employee 1.9 Import Master Data All the master data which are under Keywords can be imported from file. Page 27 of 49

28 To import master data in keyword list, from admin page, click on Import master data button at the top of the page. Figure 36: Import Master Data Button in Admin Page It will open import master data popup window like below. Figure 37: Import Master Data Window 1. Select the list name where you want to import data. Page 28 of 49

29 2. Select the file from your hard drive that you want to use for importing your data. 3. Select the column separator of your file 4. Write the column number in Column no. text box from the columns you want to import data. Remember your column start from 1 (One) not from 0(zero). 5. For data containing special characters, use file with UTF-8 encoding. 6. Click on Import Master Data button to start importing your data. When data import is completed, it will give you import completion message. Don t leave the page before import completes. If you want to import city and zip code then select Zip code from the list item dropdown list. Then the window look bit different than the previous import window. For importing zip code and city the window looks like below. Figure 38: Import City Zip code Window 1. Select file to import data from. 2. Select the name of the country, for which city and zip code you want to import. 3. Write the column number of the city of your file. 4. Write the column number of zip code of your file. 5. For data containing special characters, use file with UTF-8 encoding. 6. Click on Import Master Data button to start importing. 7. When import is completed, it will show you an import completion message. 8. Don t close the window or go the other pages while data is being imported. Page 29 of 49

30 3 Libraries Here are some libraries which are used from different tabs of this application. We should not remove any of them manually as this causes inconsistency of data and application. Documents From Contact tab we can create documents. Whenever we perform that, it actually keeps the document in this library. Document Template This is used from Mail Merge. When user wants to mail merge, it will get all the template file uploaded here. Drop Off This is the temporary storage for the s. All the from exchange server or outlook (using Harmon.ie) will be saved here. Whenever sync process is run, then the valid mails will be transfer to the library. Whenever sync process is run, the mails are transfer in this library. In the lower webpart of the contact, mails are shown from this library. And if you save any from app part, then it stores saved in this library. Library This is used by the Library tab. whenever any document uploaded from Library it is actually uploading to this library. Picture This is used for keep all the pictures which are uploaded from Company or Contact. 4 Operations The following lists are used for keeping the company, contact and SSO information. These information are maintained from different tabs like company, contact, Pipeline and others. This is the place from where the information can be administered. Company All the company information are kept through this list. The company information are divided based on information types which are a) Basic b) Other address c) Company info d) Products e) Sales Statistics f) Customer satisfaction g) Warning Page 30 of 49

31 Contact All the contact information are kept through this list. There are several types of information included here, which are a) Basic b) Address c) Marketing d) Notes SSO From the Pipeline tab, we can create new SSO, update SSO and Delete SSO from the list. As we don t have any tab in SSO new or edit window that why we didn t introduce content type here. 5 Keywords List in IGCRM All the master data are maintained using several lists, which are described in the following sections 1. City: All the city items are listed here. 2. Contact Mail List: All the contact mail items are listed here. 3. Country: All the country items are listed here. 4. Customer Satisfaction: All the customer satisfaction items are listed here. 5. District: All the district items are listed here. 6. Job Function: All contact s job function items are listed here. 7. Job Title: All the contact job title items are listed here. 8. NO of Employee: Number of employee in a company items are listed here. 9. Product: This list contains the information of Product Sold and Rival Product in Company. 10. Responsibility: All the contact responsibility items are listed here. 11. State: All the state items are listed here. Page 31 of 49

32 12. Zip Code: All the zip code items are listed here. 13. SSO Product: All the SSO Product are listed here. 6 IGlobe CRM API Description To Get Outlook Inbox API Name: GetInbox API Description: Use this web service to get outlook inbox . To Get Outlook Sent API Name: GetSentbox API Description: Use this web service to get outlook sent item. To Get Details API Name: GetMailDetail API Description: Use this web service to get details of an outlook . To Get Outlook Calendar Event API Name: GetCurrentDateEvents API Description: Use this web service to get outlook calendar event. To Authenticate App User API Name: AuthenticateAppUser API Description: Use this web service to authenticate an app user. We needed this to access iglobe CRM app from web service. To Search Company from NNE API Name: GetCompanyFromNNE API Description: Use this web service to search company from NNE service. To Update Company Information From NNE API Name: GetCompanyFromNNEByTDCID API Description: Use this web service to update a company from NNE data. To Get Company All Information From NNE API Name: GetCompanyDetailsByTDCID API Description: Use this web service to get all the company information from NNE. Life trade information, finance information and others. Page 32 of 49

33 To NNE Market Data API Name: GetNNEMarketData API Description: Use this web service to get NNE data from Marketing module. To Get Company Decision MakersfFrom NNE API Name: GetCompanyDecisionMakersByTDCID API Description: Use this information to get company decision makers from NNE. To Sync Automatically API Name: AutoSyncOutLook Data API Description: Use this web service to sync data automatically in every 20 minutes. To Sync by Click on Sync Button API Name: SyncOutLook Data API Description: Use this web service to sync data manually. From contact module when an user click on the sync button then its call this web service. To Get Keyword Data from NNE (Key value pear) API Name: GetLookUpKeyTextFromNNE API Description: Use this web service to get the keywords data from NNE, and save those data in app list. (Key and value) To Get Keyword Data from NNE (Value only) API Name: GetLookValueFromNNE API Description: Use this web service to get the keywords from NNE service. (Only value) Page 33 of 49

34 7 iglobe CRM SharePoint App User Document Browser IGlobe CRM application requires some custom setting in the browser to make it fully functional. This section will describe the compatibility and setting changes needed for the browser. Compatibility This application will perform perfectly in IE10 browser. Other browser like Google Chrome and Firefox can be used for running this application, but those will not run two functionalities where ActiveX is used. These two functionalities are a. Create meeting b. Followup Change Internet Explorer Settings To change the settings of your Internet Explorer browser, do the following steps. 1. Open the IGlobe CRM App in your Internet Explorer browser. Click on browser settings icon on the top right corner of the browser and select Internet option from the dropdown menu. Or, from the Tools menu, click Internet options (If you don't see the Tools menu, press Alt). Figure 39: IE Settings Window 1 It will open the Internet options window. Page 34 of 49

35 Figure 40: IE Settings Window 2 2. Select trusted sites zone from the Security tab and click on Sites button. Add your site in trusted zone by clicking on the add button on the trusted sites window and then close the window. 3. Set the Security level for this zone to low. 4. Click on the Custom level button from the Security tab. It will open the Security Settings window. Page 35 of 49

36 Figure 41: IE Settings Window Custom Level 5. Select Enable radio button from the Access data sources across domains options, which is under Miscellaneous section. Page 36 of 49

37 Figure 42: IE Browser Settings 6. Scroll down to find out Initialize and script Activex controls not market as safe for scripting options which is under Activex controls and plug-ins section. Select Enable radio button from the available options. Page 37 of 49

38 Figure 43: Browser Settings 7. Click on the OK button in the Security Settings Window. It will show an alert, click OK to proceed. 8. Click on the OK button in the Internet Options window to save the changes made. Your browser setting is set for the app use. 8 AppPart Settings Here is the instruction on how to setup AppPart in IGlobe CRM app. 1. From IGlobe CRM app homepage, click on Dashboard section Page 38 of 49

39 Figure 44: App Homepage to go to Dashboard Page Or If you are already inside any section of the application, then click on the Dashboard icon from right side module navigation menu. Figure 45: Go to App Dashboard Page from Other Page Page 39 of 49

40 It will take you to the app User Dashboard page. The AppPart is on the top right corner of the User Dashboard page. You can also find it in the Company or contact list page and on the Library page. Figure 46: AppPart Settings on User Dashboard Page 2. Click on the settings icon on the top right corner of the AppPart. It will show you settings dropdown window like the image below. Page 40 of 49

41 Figure 47: AppPart Settings Window 3. Write your address in field. Exp: 4. Write your password for the in password field. Exp: mypassword Write the number of s you want to see on the AppPart. 6. [Note: Number of should be numeric value, not text or decimal value].click on the Save button to save your settings for the AppPart. Wait for a while to see your inbox s. 9 Configuring the Harmon.ie in Outlook After installing the Harmon.ie for outlook, whenever user open the outlook will get a screen like following. In the right, there will have a pane for Harmon. User needs to configure it to use with the IGlobe CRM App. Page 41 of 49

42 Figure 48: Harmon.IE in Outlook For configuring this, do the following steps: 1. Click on the button next to the text Click here to add a site. This will prompt a screen like following - Page 42 of 49

43 Figure 49: IGCRM SP App Setup with Harmon.IE 2. Here user needs to provide SharePoint site URL and authentication. On clicking the OK button, it will connect to the SharePoint site and retrieve the libraries from there. If Harmon.IE fails to connect to the SharePoint site, please recheck the URL and authentication data and then try again. The libraries will show up like in the following screen. User needs to use the CRM Drop off library for drag-drop or save the s, documents etc. Page 43 of 49

44 Figure 50: Library to Link with Harmon IE After retrieving the libraries, you have to map library columns in the Harmon.IE. To map library column follow the following steps: 1. Click on the dropdown arrow from harmon.ie right corner, then click options. Figure 51: Drop Off Library Column Mapping 1 Page 44 of 49

45 2. It will show you option window like below. Select Advance tab from option windowand click on Mapping button from header mapping section. Figure 52: Drop Off Library Column Mapping 2 3. It will show you mapping window. You have to map the library columns with outlook from this window. Map library column with your outlook like below. Page 45 of 49

46 Figure 53: Drop Off Library Column Mapping 3 4. Select the row which you want to map. For example select CC row Page 46 of 49

47 Figure 54: Drop Off Library Column Mapping 4 5. Then click on Edit button, it will show you edit popup window. Or you can double click on the row to open the edit popup. Add Drop Off Library column name with existing name and click ok. Page 47 of 49

48 Figure 55: Drop Off Library Column Mapping 5 Note :Don t remove default column name from header mapping window, and separate your library mapping column name with semicolon (;) 6. Map all the columns by following the same steps. Following table shows which drop off library columns need to be mapped with your outlook header columns. Drop Off Library Columns which needs to be linked with your Harmon.IE settings Header SharePoint Columns 1 CC IGCRMMailCC 2 Date MailDate 3 From IGCRMMailFrom 4 Message-ID IGCRMMailReference 5 OriginalSubject IGCRMMailSubject 6 To IGCRMMailTo Page 48 of 49

49 7. After completing all column mapping, click on OK button to complete your column mapping. Figure 56: Drop Off Library Column Mapping 6 Drop Off library settings with your harmon.ie is done. And the feature is ready to use. User can drag and drop or save mails/documents in the Drop off Library from Harmon.IE to be synced with the IGlobe CRM App later on. Page 49 of 49