Monday, October 5, 2015

Creating and Registering add-on package SAP 9.1

Most of the SDK developer of SAP Business One are using 3rd party tool or Installshield to compile their add-on. But in the new version of SAP Business One 9.1, one the highlights for this version is the Enhanced lifecycle management for extension. This is the new light-weight approach for add-on deployment. The benefits of this update are:
  1. Simplified extension development and lifecycle management including add-ons and extreme apps.
  2. Remote control the extension lifecycle management easily without end-user interaction or system administration privilege.
    • Imagine, there's no more hustle in the end user part as they install and uninstall the add-on.
    • You don't need to call any support as the add-on failed to install in the end user part.
  3. Less time to compile the add-on less hustle to deploy the package.
To make sure that you that this things work is that:
  • Check your SLDModel.SLDData database.
    • The Identity Specification for Tasks and TaskProperties tables are set to 'No'
    • If the Identity Specification is set to 'Yes' then you should reinstall your SLD.
    Many user complain that they cannot import their add-on package in the System LandScape(SLD), the reason why is that their SLDModel.SLDData database is not updated. Their SLDModel.SLDData database came from SAP Business One 8.82 below. Though if you upgrade your SLDModel.SLDData database from SAP Business One 8.82 to SAP Business One 9.1 expect the same error as mine "Cannot reserve ID for invalid name 'TaskProperty'". To fix this error, you need to reinstall your SLD and use the SAP Business 9.1 installer.

    So lets get started.
    1. Make sure that the SAP Business One SDK is installed in your machine.
    2. Go to: "C:\Program Files (x86)\SAP\SAP Business One SDK\Tools\ExtensionPackage"
    3. Open "ExtensionPackage.exe"
    Walk through with the ExtensionPackage:


    Basic Information:
    • Extension Name is mandatory, this is your add-on name.
    • Extension Version: your add-on version
    • Extension Provider: you can input your company name
    • Extension Namespace: you can input your company name or your initials
    • Supported Database: choose platform where you deploy your add-on package
    • Contact Data: you can input your company name
    Extension File:
    • In the Open Exe file, browse your add-on exe file.
      • If  your client is using SAP Business One 32-bit then select the SBO 32-Bit Client add-on
      • If  your client is using SAP Business One 64-bit then select the SBO 64-Bit Client add-on
      • If your client is using SAP Business One for HANA then select the App for the version for SAP HANA
    • Select all the necessary files that you need in your package.
      • For example, if your add-on used .srf form.
    Deployment Steps:

    • Select all the necessary library files(DLLs) the you need in your package.
      • If  your client is using SAP Business One 32-bit then select the Register 32-Bit Microsoft COM DLLs
      • If  your client is using SAP Business One 64-bit then select the Register 64-Bit Microsoft COM DLLs
    • Common DLLs that need to include are:
      • Interop.SAPbobsCOM.dll
      • Interop.SAPbobsuiCOM.dll
    • If you created your own library kindly select it.
    SBO Compatibility:
    • Your package is compatible with SAP Business One
      • From - To
        • Example 9.0 to 9.1
    Parameters:
    • Honestly, I really don't know how to use this function.
    For the buttons:
    • Export - export your file as .ard file
    • Import - import your .ard file
    • Package - export your file as 1 file (zip) file
      • This package used in the Extension Manager of SLD. 
    If you are done with those simple steps, you may now proceed to import your add-on package to SAP Business One Extension Manager.

    To access the SAP Business One Extension Manager.
    1. Open your SAP Business One Service manager by double clicking it in your notification area.
    2. Select License Manager in Service drop down selection.
    3. Click Settings
    4. Configure Security
      • It will open your default browser. The link looks like: https://<server-name>:30010/ControlCenter/
    5. If you encounter a Certificate error, just click Continue.
    6. Login your SLD credentials. Default username: B1SiteUser
    7. If you are successfully login change the ControlCenter to ExtensionManager
    Importing your package:
    1. In the Extensions tab, kindly click Import button and browse your add-on package.
    2. After you successfully select your add-on package, click Upload.
      • If your received an error "Cannot reserve ID for invalid name 'TaskProperty'". Kindly scroll up this post.
    3. Click Next
    4. If you have parameters in your add-on package you may now put value 
    5. Click Next
    6. Then Finish
    7. Your package is now in the list.
    Company Assignment:

    You can now deploy your extension or add-on package in the specific Company database.
    1. In the Company Assignment tab, click the Company Database in the Company List that you want to assign the add-on package or extension.
    2. Click Assign button, the specify an extension or add-on package.
    3. Click Next
    4. Parameters, click Next
    5. Default Startup mode for each user.
      • You can select Default, Automatic, Manual, Disabled
    6. Click Next
    7. Then Finish
    8. Your package is now in the list for the specific Company Database.
    And you are done. :)

    Feel free to drop comments below. If you are using old school when creating and registering add-on 

    26 comments:

    1. SAP
      Thanks for sharing this niche useful informative post to our knowledge, Actually SAP is ERP software that can be used in many companies for their day to day business activities it has great scope in future.
      Regards,
      SAP training in chennai|SAP Course in Chennai|sap training in Chennai

      ReplyDelete
      Replies
      1. Thanks for dropping by Amirtha. Hopefully the world will used SAP as their ERP. :)

        Delete
    2. Hi

      I have tried installing the add-on through light weight deployment.
      It worked fine for me.

      Here is my question?

      I having X86 and X64 Add-On's when i open X64 it shows me that "X32 is not Compactible" how can i Suppress this message.

      ReplyDelete
      Replies
      1. What SBO Client you are using? Is it x86?

        Delete
      2. Yep when i open X 86 it show X64 is not compact-able

        when i open 64X it shows X 32 is not compact-able

        Sorry for the late reply tooo

        Delete
      3. Try to install x64 add-on only.

        Delete
    3. What patch level of SAP Business One are you using?

      I am on SAP 9.1 PL03, I am able to import the extension, but I don't have any companies appearing in the company list so I am not able to assign it to any companies.

      ReplyDelete
      Replies
      1. Try to re-attach the SBO-COMMON database and attached it again.

        Delete
    4. Hi Hikaru,

      I have follow your instructions. Imported package with ZIP files and assigned it to the company database are success. But the addon not appear in the Add On Manager List.

      There are missing step? I have attach and re-attach sbo-common database also.

      Thank you.

      Best Regards,
      Muh.Ulfah

      ReplyDelete
      Replies
      1. Check in pending add-on and failed add-on for light weight deployment

        Delete
    5. Hello, I have created lightweight addon but that is not connecting with company. As soon as i am connecting system showing message Addon Uninstall, Although addon is still available.

      ReplyDelete
      Replies
      1. Make sure you're running the SAP Client as an Administrator (Right-Click => Run as Administrator)
        Annoyingly, the installation/updating doesn't seem to work if it's not run as admin.

        Delete
    6. Thanks for solution plss can i am bit confused abt last few steps can u please explain me clearly Company Assignment:

      You can now deploy your extension or add-on package in the specific Company database.
      In the Company Assignment tab, click the Company Database in the Company List that you want to assign the add-on package or extension.
      Click Assign button, the specify an extension or add-on package.
      Click Next
      Parameters, click Next
      Default Startup mode for each user.
      You can select Default, Automatic, Manual, Disabled
      Click Next
      Then Finish
      Your package is now in the list for the specific Company Database.

      ReplyDelete
      Replies
      1. Company Assignment is, when you want to deploy your add-on on specific company. For example you have 2 company database. SBODemoAU and SBODemoUS. You want to deploy it only in SBODemoUS.

        Delete
    7. Hi Guys

      I am a SAP Certified consultant and want to develop some addons for a client whom I do adhoc work for.

      Only problem not I am facing is they have SBO 8.82 and I am still running 8. I no longer belong to any SAP Partner company, I do freelance work.

      So is there a way I can get a SBO 8.82 full version if you are not part of the company that is SBO Partner ?

      ReplyDelete
      Replies
      1. No, there's no way you download 8.82 family if you don't have credentials in partner edge which is basically your credentials will be given by the SAP Partner company.

        Delete
    8. How do you deploy SAP B1 (Update) Add-Ons if you are using a big Microsoft RDS Serverfarm? (without Citrix Extension)

      Is it necessary to install a new Add-On on every Server? Please tell me a better solution!

      Thank you and best regards.

      ReplyDelete
      Replies
      1. Hi, you only need to deploy on the SAP Server. And it will automatically deploy in Terminal Server or RDS Server.

        Delete
    9. Hi

      Do anyone who have experience that deploy the addon(extension) on cloud?

      I can synchronize the addon, but I can't deploy successfully.

      How can I know that it is related to addon source or not?

      Regards

      ReplyDelete
    10. This comment has been removed by the author.

      ReplyDelete
    11. Hi..
      I want to ask can we make a single package of SBO 32 bit and 64 bit client Add-on?????
      please reply asap..
      Thank you

      ReplyDelete
    12. How Do I reinstall SLD?

      ReplyDelete
    13. hello,
      i have done all steps is work in my pc but i have try another pc that not work ?
      i have create package for both wen and desktop. ...
      i have not understand what problem.....?
      pls guid me.....

      ReplyDelete
    14. hi i assign my addon to company but it not show in company. it registered successfully in SLD but not show in company.. please help

      ReplyDelete
    15. hi Hikaru Shin,

      I Successfully register add on from server, but in client add on not show in add on manager, please help me..

      ReplyDelete
    16. hi Hikaru Shin,

      I Successfully register add on from server, but in client add on not show in add on manager, please help me..

      ReplyDelete