Skip to content

Latest commit

 

History

History
130 lines (63 loc) · 6.84 KB

Phase3Beta.md

File metadata and controls

130 lines (63 loc) · 6.84 KB

Acumatica Surveys Phase 3 (Beta) README

August 3rd 2021

Please note that this release is in large part a "re-architecture" of the Surveys project as we have expanded the functionality greatly, requiring rewriting a large portion of code.

Setup Instructions for Installing the Phase 3 Acumatica Surveys package

Step One: Download the customization package (AcumaticaSurveyPkg.zip) appropriate for your version of Acumatica. Curently, we support the following versions:

Acumatica 2020 R2 Build 20.212.0038 onward

To download the customization package for 2020R2, click here. *Needs updating.

Step Two: Go to your Project Customization Screen. You may just do a quick searach by typing "Customization" then selecting it as follows.

Step Three: Upload & import the package you downloaded to your Acumatica 2020R2 instance by clicking on the Customization menu which you will now find in the upper-righthand of the Acumatica application. Then select Manage Customizations from the drop down list as illustrated below.

Next, click on the Import tab and select "Import New Project" from the dropdown list as shown below.

Then click on Choose File to open up the File Manager to select the Acumatic Surveys package.

Step Four: After the package is uploaded, you will need to publish it. Select the package you just uploaded by clicking on its associated checkbox to the left and then click on the Publish tab to publish your package. Once it's published, you are ready to create your first Survey!

After the validation process has successfully completed, click on the "Publish" button in the Compilation window:

If successful, you will see that the website was updated and you can continue.

At this point you will see that Surveys now appears at the bottom of the left pane. Click on it and you will see all the elements for mananging and creating new Surveys.

You should see the following items as seen in the screenshot above:

Surveys (Transactions)

Survey Collectors (Transactions)

Process Surveys (Processes)

Survey Response View (Inquiries)

Survey Answers (Inquiries)

Survey Preferences (Preferences)

Survey Components (Preferences)

Survey View (Dashboards)

We'll discuss all these items later in the documentation as appropriate.

Importing/Copying the Base Survey Components

If you have installed previous versions of Acumatica Surveys, this is a new step for you in setting up Surveys. These components are the initial building blocks you will need to use and create Acumatica Surveys. After installing these, you will be able to make copies and alter them as you please, futher customizing any surveys you choose to create. This can be done either yourself, or by someone else in or outside of your organization. These components provide nearly limitless flexibility for you to control the "look and feel" - along with the functionality beyond a simple survey. More on this later.

Assuming you successfully published the Acumatica Surveys package, click on Surveys in the lower left pane and then click on Survey Components. You will notice you don't have any components at this point. You will need to install them manually.

To install the base components, download the Survey Components here.

After downloading the Survey Components, you can now import each as XML as follows.

Once you unpack the zip into a folder, you can add each component one by one. As an example, the SUMAIN component is imported from the file SurveyComponents-SUMain.xml

Important: Once imported, you need to choose the correct Component Type. For this particular component, you will choose Survey as it's component type in the drop-down.

For reference, here is a list of components and their associated types that you much use in order for them to function properly.

Finish completing each of the components that you have downloaded and you are finished and now can configure a variety settings and configurations to customize any surveys you wish to create.

End of intial edits/creation of the beta documentation...

Survey Preferences (Main Configuration Screen)

Now that the package is installed and the components have been imported, let's take a look at some of the configuration options. Open the Survey Preferences screen.

Click on the Survey Preferences menu option.

Survey preferences - Surveys require a numbering sequence. Therefore, please set up a new number sequence called “Survey ID” and an auto generating number, such as: SV10001

Select the numbering sequence you created in the Survey Preferences “Survey Numbering ID:” Surveys utilizes common attributes to create questions and answers. Therefore, please setup any new questions/answers as attributes.

After you have setup required attributes, you are now ready to create your first survey!

Create a Survey

Click on Surveys in the workspace and click Survey under Transactions.

The survey primary list screen (SV2010PL) loads with empty records. Click on the + to create a new survey which opens the new screen SV201000